00001 /* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
00002  *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
00003  *
00004  *  Copyright (C) 2008 Sun Microsystems, Toru Maesaka
00005  *  Copyright (C) 2010 Djellel Eddine Difallah
00006  *
00007  *  This program is free software; you can redistribute it and/or modify
00008  *  it under the terms of the GNU General Public License as published by
00009  *  the Free Software Foundation; version 2 of the License.
00010  *
00011  *  This program is distributed in the hope that it will be useful,
00012  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  *  GNU General Public License for more details.
00015  *
00016  *  You should have received a copy of the GNU General Public License
00017  *  along with this program; if not, write to the Free Software
00018  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00019  */
00020 
00021 #pragma once
00022 
00023 #include <drizzled/plugin.h>
00024 #include <drizzled/plugin/plugin.h>
00025 #include <drizzled/sql_list.h>
00026 #include <drizzled/visibility.h>
00027 
00028 namespace drizzled {
00029 namespace plugin {
00030 
00031 /* 
00032   This is the API that a qcache plugin must implement.
00033 */
00034 
00035 class DRIZZLED_API QueryCache : public Plugin
00036 {
00037 public:  
00038   explicit QueryCache(const std::string& name)
00039     : Plugin(name, "QueryCache")
00040   {}
00041 
00042   /* these are the Query Cache interface functions */
00043 
00044   /* Lookup the cache and transmit the data back to the client */
00045   virtual bool doIsCached(Session*)= 0;  
00046   /* Lookup the cache and transmit the data back to the client */
00047   virtual bool doSendCachedResultset(Session*)= 0;
00048   /* Send the current Resultset to the cache */
00049   virtual bool doSetResultset(Session*)= 0;
00050   /* initiate a new Resultset (header) */
00051   virtual bool doPrepareResultset(Session*)= 0;
00052   /* push a record to the current Resultset */
00053   virtual bool doInsertRecord(Session*, List<Item>&)= 0;
00054 
00055   static bool addPlugin(QueryCache*);
00056   static void removePlugin(QueryCache*);
00057 
00058   /* These are the functions called by the rest of the Drizzle server */
00059   static bool isCached(Session*);
00060   static bool sendCachedResultset(Session*);
00061   static bool prepareResultset(Session*);
00062   static bool setResultset(Session*);
00063   static bool insertRecord(Session*, List<Item>&);
00064 };
00065 
00066 } /* namespace plugin */
00067 } /* namespace drizzled */
Drizzled Public API Documentation
