← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/plugin/scheduler.h

  • Committer: Monty Taylor
  • Date: 2008-09-16 00:00:48 UTC
  • mto: This revision was merged to the branch mainline in revision 391.
  • Revision ID: monty@inaugust.com-20080916000048-3rvrv3gv9l0ad3gs
Fixed copyright headers in drizzled/

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/plugin/scheduler.h
1
 
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
 
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3
 
 *
4
 
 *  Definitions required for Configuration Variables plugin
5
 
 *
6
 
 *  Copyright (C) 2008 Sun Microsystems, Inc.
7
 
 *
8
 
 *  This program is free software; you can redistribute it and/or modify
9
 
 *  it under the terms of the GNU General Public License as published by
10
 
 *  the Free Software Foundation; version 2 of the License.
11
 
 *
12
 
 *  This program is distributed in the hope that it will be useful,
13
 
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14
 
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15
 
 *  GNU General Public License for more details.
16
 
 *
17
 
 *  You should have received a copy of the GNU General Public License
18
 
 *  along with this program; if not, write to the Free Software
19
 
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
20
 
 */
21
 
 
22
 
#ifndef DRIZZLED_PLUGIN_SCHEDULER_H
23
 
#define DRIZZLED_PLUGIN_SCHEDULER_H
24
 
 
25
 
#include "drizzled/session.h"
26
 
#include "drizzled/plugin/plugin.h"
27
 
 
28
 
#include <string>
29
 
#include <vector>
30
 
 
31
 
#include "drizzled/visibility.h"
32
 
 
33
 
namespace drizzled
34
 
{
35
 
 
36
 
class Session;
37
 
 
38
 
namespace plugin
39
 
{
40
 
 
41
 
/**
42
 
 * This class should be used by scheduler plugins to implement custom session
43
 
 * schedulers.
44
 
 */
45
 
class DRIZZLED_API Scheduler : public Plugin
46
 
{
47
 
  /* Disable default constructors */
48
 
  Scheduler();
49
 
  Scheduler(const Scheduler &);
50
 
  Scheduler& operator=(const Scheduler &);
51
 
public:
52
 
  explicit Scheduler(std::string name_arg)
53
 
    : Plugin(name_arg, "Scheduler")
54
 
  {}
55
 
  virtual ~Scheduler() {}
56
 
 
57
 
  /**
58
 
   * Add a session to the scheduler. When the scheduler is ready to run the
59
 
   * session, it should call session->run().
60
 
   */
61
 
  virtual bool addSession(Session::shared_ptr &session)= 0;
62
 
 
63
 
  /**
64
 
   * Notify the scheduler that it should be killed gracefully.
65
 
   */
66
 
  virtual void killSession(Session *) {}
67
 
 
68
 
  /**
69
 
   * This is called when a scheduler should kill the session immedaitely.
70
 
   */
71
 
  virtual void killSessionNow(Session::shared_ptr&) {}
72
 
 
73
 
  static bool addPlugin(plugin::Scheduler *sced);
74
 
  static void removePlugin(plugin::Scheduler *sced);
75
 
  static bool setPlugin(const std::string& name);
76
 
  static Scheduler *getScheduler();
77
 
};
78
 
 
79
 
} /* namespace plugin */
80
 
} /* namespace drizzled */
81
 
 
82
 
#endif /* DRIZZLED_PLUGIN_SCHEDULER_H */