← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/plugin/transaction_applier.h

  • Committer: Brian Aker
  • Date: 2008-07-08 16:17:31 UTC
  • Revision ID: brian@tangent.org-20080708161731-io36j7igglok79py
DATE cleanup.

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/plugin/transaction_applier.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
5
 
 *  Copyright (c) 2010 Jay Pipes
6
 
 *
7
 
 *  Authors:
8
 
 *
9
 
 *    Jay Pipes <jaypipes@gmail.com>
10
 
 *
11
 
 *  This program is free software; you can redistribute it and/or modify
12
 
 *  it under the terms of the GNU General Public License as published by
13
 
 *  the Free Software Foundation; version 2 of the License.
14
 
 *
15
 
 *  This program is distributed in the hope that it will be useful,
16
 
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
17
 
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
 
 *  GNU General Public License for more details.
19
 
 *
20
 
 *  You should have received a copy of the GNU General Public License
21
 
 *  along with this program; if not, write to the Free Software
22
 
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
23
 
 */
24
 
 
25
 
#ifndef DRIZZLED_PLUGIN_TRANSACTION_APPLIER_H
26
 
#define DRIZZLED_PLUGIN_TRANSACTION_APPLIER_H
27
 
 
28
 
/**
29
 
 * @file Defines the API for a TransactionApplier
30
 
 *
31
 
 * A TransactionApplier applies an event it has received from a TransactionReplicator (via 
32
 
 * a replicator's replicate() call, or it has read using a TransactionReader's read()
33
 
 * call.
34
 
 */
35
 
 
36
 
#include "drizzled/plugin/plugin.h"
37
 
#include "drizzled/plugin/replication.h"
38
 
 
39
 
namespace drizzled
40
 
{
41
 
 
42
 
class Session;
43
 
 
44
 
namespace message { class Transaction; }
45
 
 
46
 
namespace plugin
47
 
{
48
 
 
49
 
/**
50
 
 * Base class for appliers of Transaction messages
51
 
 */
52
 
class TransactionApplier : public Plugin
53
 
{
54
 
  TransactionApplier();
55
 
  TransactionApplier(const TransactionApplier &);
56
 
  TransactionApplier& operator=(const TransactionApplier &);
57
 
public:
58
 
  explicit TransactionApplier(std::string name_arg)
59
 
    : Plugin(name_arg, "TransactionApplier")
60
 
  {
61
 
  }
62
 
  virtual ~TransactionApplier() {}
63
 
  /**
64
 
   * Apply something to a target.
65
 
   *
66
 
   * @note
67
 
   *
68
 
   * It is important to note that memory allocation for the 
69
 
   * supplied pointer is not guaranteed after the completion 
70
 
   * of this function -- meaning the caller can dispose of the
71
 
   * supplied message.  Therefore, appliers which are
72
 
   * implementing an asynchronous replication system must copy
73
 
   * the supplied message to their own controlled memory storage
74
 
   * area.
75
 
   *
76
 
   * @param Transaction message to be replicated
77
 
   */
78
 
  virtual ReplicationReturnCode apply(Session &in_session,
79
 
                                      const message::Transaction &to_apply)= 0;
80
 
 
81
 
  static bool addPlugin(TransactionApplier *applier);
82
 
  static void removePlugin(TransactionApplier *applier);
83
 
};
84
 
 
85
 
} /* namespace plugin */
86
 
} /* namespace drizzled */
87
 
 
88
 
#endif /* DRIZZLED_PLUGIN_TRANSACTION_APPLIER_H */