← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/plugin/transaction_reader.h

  • Committer: Mark Atwood
  • Date: 2012-01-03 02:42:00 UTC
  • mfrom: (2482.1.2 drizzle-build)
  • Revision ID: me@mark.atwood.name-20120103024200-2kjnoze027o3dnwy
merge lp:~brianaker/drizzle/icc-warnings

Show diffs side-by-side

added added

removed removed

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