1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
*
* Copyright (C) 2008-2009 Sun Microsystems
*
* Authors:
*
* Jay Pipes <joinfu@sun.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef DRIZZLED_PLUGIN_COMMAND_READER_H
#define DRIZZLED_PLUGIN_COMMAND_READER_H
#include <drizzled/replication_services.h> /* For global transaction ID typedef */
/**
* @file Defines the API for a CommandReader
*
* A command reader is a class which is able to read Command messages from some source
*/
namespace drizzled
{
/* some forward declarations needed */
namespace message { class Command; }
namespace plugin
{
/**
* Class which can read Command messages from some source
*/
class CommandReader : public Plugin
{
CommandReader();
CommandReader(const CommandReader &);
CommandReader& operator=(const CommandReader &);
public:
explicit CommandReader(std::string name_arg) : Plugin(name_arg) {}
virtual ~CommandReader() {}
/**
* Read and fill a Command message with the supplied
* Command message global transaction ID.
*
* @param Global transaction ID to find
* @param Pointer to a command message to fill
*
* @retval
* true if Command message was read successfully and the supplied pointer
* to message was filled
* @retval
* false if not found or read successfully
*/
virtual bool read(const ReplicationServices::GlobalTransactionId &to_read,
message::Command *to_fill)= 0;
};
} /* end namespace drizzled::plugin */
} /* end namespace drizzled */
#endif /* DRIZZLED_PLUGIN_COMMAND_READER_H */
|