← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/slave/queue_thread.h

  • Committer: Monty Taylor
  • Date: 2011-02-13 17:26:39 UTC
  • mfrom: (2157.2.2 give-in-to-pkg-config)
  • mto: This revision was merged to the branch mainline in revision 2166.
  • Revision ID: mordred@inaugust.com-20110213172639-nhy7i72sfhoq13ms
Merged in pkg-config fixes.

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
 
#pragma once
22
 
 
23
 
#include <drizzled/internal/my_pthread.h>
24
 
 
25
 
namespace slave
26
 
{
27
 
 
28
 
/**
29
 
 * Interface for threads interacting with the replication queue.
30
 
 *
31
 
 * This class uses the Template Method design pattern to define the set of
32
 
 * steps for a thread operating on the replication queue. An implementing
33
 
 * class need only implement the init(), process(), and/or shutdown() methods.
34
 
 * The implementing class need only pass run() method to thread initialization.
35
 
 */
36
 
 
37
 
class QueueThread
38
 
{
39
 
public:
40
 
  virtual ~QueueThread()
41
 
  {}
42
 
  
43
 
  void run(void);
44
 
 
45
 
  /**
46
 
   * Do any initialization work.
47
 
   *
48
 
   * @retval true Success
49
 
   * @retval false Failure
50
 
   */
51
 
  virtual bool init()
52
 
  {
53
 
    return true;
54
 
  }
55
 
 
56
 
  /**
57
 
   * Work to do at thread shutdown time.
58
 
   */
59
 
  virtual void shutdown()
60
 
  {}
61
 
 
62
 
  /**
63
 
   * Method that actually does the work around the queue.
64
 
   *
65
 
   * Returning 'false' from this method currently causes the thread to
66
 
   * shutdown.
67
 
   *
68
 
   * @retval true Success
69
 
   * @retval false Failure
70
 
   */
71
 
  virtual bool process()= 0;
72
 
 
73
 
  virtual uint32_t getSleepInterval()= 0;
74
 
};
75
 
 
76
 
} /* namespace slave */
77