← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/slave/queue_thread.h

  • Committer: Olaf van der Spek
  • Date: 2011-02-28 14:09:50 UTC
  • mfrom: (2207 bootstrap)
  • mto: (2209.1.2 build)
  • mto: This revision was merged to the branch mainline in revision 2210.
  • Revision ID: olafvdspek@gmail.com-20110228140950-2nu0hyzhuww3wssx
Merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/slave/queue_thread.h
 
1
/* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
 
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 
3
 *
 
4
 *  Copyright (C) 2011 David Shrewsbury
 
5
 *
 
6
 *  This program is free software; you can redistribute it and/or modify
 
7
 *  it under the terms of the GNU General Public License as published by
 
8
 *  the Free Software Foundation; either version 2 of the License, or
 
9
 *  (at your option) any later version.
 
10
 *
 
11
 *  This program is distributed in the hope that it will be useful,
 
12
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
14
 *  GNU General Public License for more details.
 
15
 *
 
16
 *  You should have received a copy of the GNU General Public License
 
17
 *  along with this program; if not, write to the Free Software
 
18
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
19
 */
 
20
 
 
21
#ifndef PLUGIN_SLAVE_QUEUE_THREAD_H
 
22
#define PLUGIN_SLAVE_QUEUE_THREAD_H
 
23
 
 
24
#include <drizzled/internal/my_pthread.h>
 
25
 
 
26
namespace slave
 
27
{
 
28
 
 
29
/**
 
30
 * Interface for threads interacting with the replication queue.
 
31
 *
 
32
 * This class uses the Template Method design pattern to define the set of
 
33
 * steps for a thread operating on the replication queue. An implementing
 
34
 * class need only implement the init(), process(), and/or shutdown() methods.
 
35
 * The implementing class need only pass run() method to thread initialization.
 
36
 */
 
37
 
 
38
class QueueThread
 
39
{
 
40
public:
 
41
  virtual ~QueueThread()
 
42
  {}
 
43
  
 
44
  void run(void);
 
45
 
 
46
  /**
 
47
   * Do any initialization work.
 
48
   *
 
49
   * @retval true Success
 
50
   * @retval false Failure
 
51
   */
 
52
  virtual bool init()
 
53
  {
 
54
    return true;
 
55
  }
 
56
 
 
57
  /**
 
58
   * Work to do at thread shutdown time.
 
59
   */
 
60
  virtual void shutdown()
 
61
  {}
 
62
 
 
63
  /**
 
64
   * Method that actually does the work around the queue.
 
65
   *
 
66
   * Returning 'false' from this method currently causes the thread to
 
67
   * shutdown.
 
68
   *
 
69
   * @retval true Success
 
70
   * @retval false Failure
 
71
   */
 
72
  virtual bool process()= 0;
 
73
 
 
74
  virtual uint32_t getSleepInterval()= 0;
 
75
};
 
76
 
 
77
} /* namespace slave */
 
78
 
 
79
#endif /* PLUGIN_SLAVE_QUEUE_THREAD_H */