← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/resource_context.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/resource_context.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 Sun Microsystems
5
 
 *  Copyright (c) 2010 Jay Pipes <jaypipes@gmail.com>
6
 
 *
7
 
 *  This program is free software; you can redistribute it and/or modify
8
 
 *  it under the terms of the GNU General Public License as published by
9
 
 *  the Free Software Foundation; version 2 of the License.
10
 
 *
11
 
 *  This program is distributed in the hope that it will be useful,
12
 
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13
 
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14
 
 *  GNU General Public License for more details.
15
 
 *
16
 
 *  You should have received a copy of the GNU General Public License
17
 
 *  along with this program; if not, write to the Free Software
18
 
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19
 
 */
20
 
 
21
 
#ifndef DRIZZLED_RESOURCE_CONTEXT_H
22
 
#define DRIZZLED_RESOURCE_CONTEXT_H
23
 
 
24
 
#include <cstddef>
25
 
 
26
 
namespace drizzled
27
 
{
28
 
 
29
 
namespace plugin
30
 
{
31
 
class MonitoredInTransaction;
32
 
class TransactionalStorageEngine;
33
 
class XaResourceManager;
34
 
}
35
 
 
36
 
/**
37
 
 * Either statement transaction or normal transaction - related
38
 
 * session-specific resource manager data state.
39
 
 *
40
 
 * If a resource manager participates in a statement/transaction,
41
 
 * an instance of this class is present in
42
 
 * session->transaction.{stmt|all}.resource_contexts.
43
 
 *
44
 
 * When it's time to commit or rollback, each resource context
45
 
 * is used to access the resource manager's prepare()/commit()/rollback()
46
 
 * methods, and also to evaluate if a full two phase commit is
47
 
 * necessary.
48
 
 * 
49
 
 * @sa General description of transaction handling in drizzled/transaction_services.cc.
50
 
 */
51
 
class ResourceContext
52
 
{
53
 
public:
54
 
  ResourceContext() :
55
 
    monitored(NULL),
56
 
    xa_resource_manager(NULL),
57
 
    trx_storage_engine(NULL),
58
 
    modified_data(false)
59
 
  {}
60
 
 
61
 
  /** Clear, prepare for reuse. */
62
 
  void reset();
63
 
 
64
 
  /**
65
 
   * Marks that the underlying resource manager
66
 
   * has modified data state.
67
 
   */
68
 
  void markModifiedData();
69
 
 
70
 
  /**
71
 
   * Returns true if the underlying resource manager
72
 
   * has modified data state.
73
 
   */
74
 
  bool hasModifiedData() const;
75
 
 
76
 
  /**
77
 
   * Returns true if the underlying resource
78
 
   * manager has registered with the transaction
79
 
   * manager for this transaction.
80
 
   */
81
 
  bool isStarted() const;
82
 
 
83
 
  /** 
84
 
   * Mark this context as modifying data if the argument has also modified data
85
 
   */
86
 
  void coalesceWith(const ResourceContext *stmt_trx);
87
 
 
88
 
  /**
89
 
   * Returns the underlying descriptor for the resource
90
 
   * this context tracks.
91
 
   */
92
 
  plugin::MonitoredInTransaction *getMonitored() const
93
 
  {
94
 
    return monitored;
95
 
  }
96
 
 
97
 
  /**
98
 
   * Sets the underlying descriptor for the resource
99
 
   */
100
 
  void setMonitored(plugin::MonitoredInTransaction *in_monitored)
101
 
  {
102
 
    monitored= in_monitored;
103
 
  }
104
 
 
105
 
  /**
106
 
   * Returns the underlying transactional storage engine
107
 
   * this context tracks or NULL if not SQL transactional capable.
108
 
   */
109
 
  plugin::TransactionalStorageEngine *getTransactionalStorageEngine() const
110
 
  {
111
 
    return trx_storage_engine;
112
 
  }
113
 
 
114
 
  /**
115
 
   * Sets the underlying transactional storage engine
116
 
   */
117
 
  void setTransactionalStorageEngine(plugin::TransactionalStorageEngine *in_trx_storage_engine)
118
 
  {
119
 
    trx_storage_engine= in_trx_storage_engine;
120
 
  }
121
 
 
122
 
  /**
123
 
   * Returns the underlying XA resource manager
124
 
   * this context tracks or NULL if not XA capable.
125
 
   */
126
 
  plugin::XaResourceManager *getXaResourceManager() const
127
 
  {
128
 
    return xa_resource_manager;
129
 
  }
130
 
 
131
 
  /**
132
 
   * Sets the underlying xa resource manager
133
 
   */
134
 
  void setXaResourceManager(plugin::XaResourceManager *in_xa_resource_manager)
135
 
  {
136
 
    xa_resource_manager= in_xa_resource_manager;
137
 
  }
138
 
private:
139
 
  /**
140
 
   * A descriptor of the monitored resource
141
 
   */
142
 
  plugin::MonitoredInTransaction *monitored;
143
 
  /**
144
 
   * The XA resource manager or NULL if not XA capable.
145
 
   */
146
 
  plugin::XaResourceManager *xa_resource_manager;
147
 
  /**
148
 
   * The transactional storage engine or NULL if not SQL transaction capable.
149
 
   */
150
 
  plugin::TransactionalStorageEngine *trx_storage_engine;
151
 
  /**
152
 
   * Whether the underlying resource manager has changed
153
 
   * some data state.
154
 
   */
155
 
  bool modified_data;
156
 
};
157
 
 
158
 
} /* namespace drizzled */
159
 
 
160
 
#endif /* DRIZZLED_RESOURCE_CONTEXT_H */