← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/command_log/command_log.h

Renames serial event log to command log

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/command_log/command_log.h
21
21
/**
22
22
 * @file
23
23
 *
24
 
 * Defines the API of the default serial event log.
 
24
 * Defines the API of the default command log.
25
25
 *
26
26
 * @see drizzled/plugin/replicator.h
27
27
 * @see drizzled/plugin/applier.h
28
28
 *
29
29
 * @details
30
30
 *
31
 
 * The SerialEventLog applies events it receives from the TransactionServices
 
31
 * The CommandLog applies events it receives from the TransactionServices
32
32
 * server component to a simple log file on disk.
33
33
 * 
34
 
 * Events are received in no guaranteed order and the serial event log
 
34
 * Events are received in no guaranteed order and the command log
35
35
 * is in charge of writing these events to the log as they are received.
36
36
 */
37
37
 
38
 
#ifndef DRIZZLE_PLUGIN_SERIAL_EVENT_LOG_H
39
 
#define DRIZZLE_PLUGIN_SERIAL_EVENT_LOG_H
 
38
#ifndef DRIZZLE_PLUGIN_command_log_H
 
39
#define DRIZZLE_PLUGIN_command_log_H
40
40
 
41
41
#include <drizzled/server_includes.h>
42
42
#include <drizzled/atomics.h>
46
46
#include <vector>
47
47
#include <string>
48
48
 
49
 
class SerialEventLog: public drizzled::plugin::Applier 
 
49
class CommandLog: public drizzled::plugin::Applier 
50
50
{
51
51
public:
52
52
  enum status
59
59
private:
60
60
  int log_file; /**< Handle for our log file */
61
61
  enum status state; /**< The state the log is in */
62
 
  drizzled::atomic<bool> is_enabled; /**< Internal toggle. Atomic to support online toggling of serial event log... */
 
62
  drizzled::atomic<bool> is_enabled; /**< Internal toggle. Atomic to support online toggling of command log... */
63
63
  drizzled::atomic<bool> is_active; /**< Internal toggle. If true, log was initialized properly... */
64
64
  const char *log_file_path; /**< Full path to the log file */
65
65
  drizzled::atomic<off_t> log_offset; /**< Offset in log file where log will write next command */
66
66
public:
67
 
  SerialEventLog(const char *in_log_file_path);
 
67
  CommandLog(const char *in_log_file_path);
68
68
 
69
69
  /** Destructor */
70
 
  ~SerialEventLog();
 
70
  ~CommandLog();
71
71
 
72
72
  /**
73
73
   * Applies a Command to the serial log
87
87
  void apply(drizzled::message::Command *to_apply);
88
88
  
89
89
  /** 
90
 
   * Returns whether the serial event log is active.
 
90
   * Returns whether the command log is active.
91
91
   */
92
92
  bool isActive();
93
93
 
94
94
  /**
95
95
   * Disables the plugin.
96
 
   * Disabled just means that the user has done an online set @serial_event_log_enable= false
 
96
   * Disabled just means that the user has done an online set @command_log_enable= false
97
97
   */
98
98
  inline void disable()
99
99
  {
102
102
 
103
103
  /**
104
104
   * Enables the plugin.  Enabling is a bit different from isActive().
105
 
   * Enabled just means that the user has done an online set @serial_event_log_enable= true
106
 
   * or has manually started up the server with --serial-event-log-enable
 
105
   * Enabled just means that the user has done an online set global command_log_enable= true
 
106
   * or has manually started up the server with --command-log-enable
107
107
   */
108
108
  inline void enable()
109
109
  {
124
124
   * @note 
125
125
   *
126
126
   * This is only called currently during debugging and testing of the 
127
 
   * serial event log...when the @serial_event_log.truncate variable is 
 
127
   * command log...when the global command_log_truncate variable is 
128
128
   * set to anything other than false, this is called.
129
129
   */
130
130
  void truncate();
131
131
};
132
132
 
133
 
#endif /* DRIZZLE_PLUGIN_SERIAL_EVENT_LOG_H */
 
133
#endif /* DRIZZLE_PLUGIN_command_log_H */