← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/replication_services.h

  • Committer: Stewart Smith
  • Date: 2008-10-15 04:21:24 UTC
  • mto: This revision was merged to the branch mainline in revision 516.
  • Revision ID: stewart@flamingspork.com-20081015042124-kdmb74bcbky1k1nz
remove my_pthread_[gs]etspecific

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/replication_services.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
 
 *  Copyright (C) 2009-2010 Jay Pipes <jaypipes@gmail.com>
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_REPLICATION_SERVICES_H
26
 
#define DRIZZLED_REPLICATION_SERVICES_H
27
 
 
28
 
#include <drizzled/atomics.h>
29
 
#include <drizzled/plugin/replication.h>
30
 
 
31
 
#include <string>
32
 
#include <vector>
33
 
#include <utility>
34
 
 
35
 
#include <drizzled/visibility.h>
36
 
 
37
 
namespace drizzled
38
 
{
39
 
 
40
 
/* some forward declarations needed */
41
 
class Session;
42
 
class Table;
43
 
 
44
 
namespace plugin
45
 
{
46
 
  class TransactionReplicator;
47
 
  class TransactionApplier;
48
 
}
49
 
namespace message
50
 
{
51
 
  class Transaction;
52
 
}
53
 
 
54
 
/**
55
 
 * This is a class which manages transforming internal 
56
 
 * transactional events into GPB messages and sending those
57
 
 * events out through registered replicators and appliers.
58
 
 */
59
 
class DRIZZLED_API ReplicationServices
60
 
{
61
 
public:
62
 
  typedef uint64_t GlobalTransactionId;
63
 
  /**
64
 
   * Types of messages that can go in the transaction
65
 
   * log file.  Every time something is written into the
66
 
   * transaction log, it is preceded by a header containing
67
 
   * the type of message which follows.
68
 
   */
69
 
  enum MessageType
70
 
  {
71
 
    TRANSACTION= 1, /* A GPB Transaction Message */
72
 
    BLOB= 2 /* A BLOB value */
73
 
  };
74
 
  typedef std::pair<plugin::TransactionReplicator *, plugin::TransactionApplier *> ReplicationPair;
75
 
  typedef std::vector<ReplicationPair> ReplicationStreams;
76
 
  /**
77
 
   * Method which is called after plugins have been loaded but
78
 
   * before the first client connects.  It determines if the registration
79
 
   * of applier and replicator plugins is proper and pairs
80
 
   * the applier and requested replicator plugins into the replication
81
 
   * streams.
82
 
   *
83
 
   * @todo
84
 
   *
85
 
   * This is only necessary because we don't yet have plugin dependency
86
 
   * tracking...
87
 
   */
88
 
  bool evaluateRegisteredPlugins();
89
 
  /** 
90
 
   * Helper method which pushes a constructed message out to the registered
91
 
   * replicator and applier plugins.
92
 
   *
93
 
   * @param Session descriptor
94
 
   * @param Message to push out
95
 
   */
96
 
  plugin::ReplicationReturnCode pushTransactionMessage(Session &in_session,
97
 
                                                       message::Transaction &to_push);
98
 
  /**
99
 
   * Constructor
100
 
   */
101
 
  ReplicationServices();
102
 
 
103
 
  /**
104
 
   * Singleton method
105
 
   * Returns the singleton instance of ReplicationServices
106
 
   */
107
 
  static inline ReplicationServices &singleton()
108
 
  {
109
 
    static ReplicationServices replication_services;
110
 
    return replication_services;
111
 
  }
112
 
 
113
 
  /**
114
 
   * Returns whether the ReplicationServices object
115
 
   * is active.  In other words, does it have both
116
 
   * a replicator and an applier that are *active*?
117
 
   */
118
 
  bool isActive() const;
119
 
 
120
 
  /**
121
 
   * Returns the list of replication streams
122
 
   */
123
 
  ReplicationStreams &getReplicationStreams();
124
 
 
125
 
  /**
126
 
   * Attaches a replicator to our internal collection of
127
 
   * replicators.
128
 
   *
129
 
   * @param Pointer to a replicator to attach/register
130
 
   */
131
 
  void attachReplicator(plugin::TransactionReplicator *in_replicator);
132
 
  
133
 
  /**
134
 
   * Detaches/unregisters a replicator with our internal
135
 
   * collection of replicators.
136
 
   *
137
 
   * @param Pointer to the replicator to detach
138
 
   */
139
 
  void detachReplicator(plugin::TransactionReplicator *in_replicator);
140
 
  
141
 
  /**
142
 
   * Attaches a applier to our internal collection of
143
 
   * appliers.
144
 
   *
145
 
   * @param Pointer to a applier to attach/register
146
 
   * @param The name of the replicator to pair with
147
 
   */
148
 
  void attachApplier(plugin::TransactionApplier *in_applier, const std::string &requested_replicator);
149
 
  
150
 
  /**
151
 
   * Detaches/unregisters a applier with our internal
152
 
   * collection of appliers.
153
 
   *
154
 
   * @param Pointer to the applier to detach
155
 
   */
156
 
  void detachApplier(plugin::TransactionApplier *in_applier);
157
 
 
158
 
  /** 
159
 
   * Returns the timestamp of the last Transaction which was sent to an
160
 
   * applier.
161
 
   */
162
 
  uint64_t getLastAppliedTimestamp() const;
163
 
private:
164
 
  typedef std::vector<plugin::TransactionReplicator *> Replicators;
165
 
  typedef std::vector<std::pair<std::string, plugin::TransactionApplier *> > Appliers;
166
 
  /** 
167
 
   * Atomic boolean set to true if any *active* replicators
168
 
   * or appliers are actually registered.
169
 
   */
170
 
  bool is_active;
171
 
  /**
172
 
   * The timestamp of the last time a Transaction message was successfully
173
 
   * applied (sent to an Applier)
174
 
   */
175
 
  atomic<uint64_t> last_applied_timestamp;
176
 
  /** Our collection of registered replicator plugins */
177
 
  Replicators replicators;
178
 
  /** Our collection of registered applier plugins and their requested replicator plugin names */
179
 
  Appliers appliers;
180
 
  /** Our replication streams */
181
 
  ReplicationStreams replication_streams;
182
 
  /**
183
 
   * Strips underscores and lowercases supplied replicator name
184
 
   * or requested name, and appends the suffix "replicator" if missing...
185
 
   */
186
 
  void normalizeReplicatorName(std::string &name);
187
 
};
188
 
 
189
 
} /* namespace drizzled */
190
 
 
191
 
#endif /* DRIZZLED_REPLICATION_SERVICES_H */