Drizzled Public API Documentation

scheduler.h
00001 /* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
00002  *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
00003  *
00004  *  Definitions required for Configuration Variables plugin
00005  *
00006  *  Copyright (C) 2008 Sun Microsystems, Inc.
00007  *
00008  *  This program is free software; you can redistribute it and/or modify
00009  *  it under the terms of the GNU General Public License as published by
00010  *  the Free Software Foundation; version 2 of the License.
00011  *
00012  *  This program is distributed in the hope that it will be useful,
00013  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  *  GNU General Public License for more details.
00016  *
00017  *  You should have received a copy of the GNU General Public License
00018  *  along with this program; if not, write to the Free Software
00019  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00020  */
00021 
00022 #pragma once
00023 
00024 #include <drizzled/plugin/plugin.h>
00025 #include <drizzled/session.h>
00026 #include <drizzled/visibility.h>
00027 
00028 namespace drizzled {
00029 namespace plugin {
00030 
00035 class DRIZZLED_API Scheduler : public Plugin
00036 {
00037 public:
00038   explicit Scheduler(std::string name_arg)
00039     : Plugin(name_arg, "Scheduler")
00040   {}
00041 
00046   virtual bool addSession(const Session::shared_ptr&)= 0;
00047 
00051   virtual void killSession(Session*) {}
00052 
00056   virtual void killSessionNow(const Session::shared_ptr&) {}
00057 
00058   static bool addPlugin(plugin::Scheduler*);
00059   static void removePlugin(plugin::Scheduler*);
00060   static bool setPlugin(const std::string& name);
00061   static Scheduler* getScheduler();
00062 };
00063 
00064 } /* namespace plugin */
00065 } /* namespace drizzled */
00066