← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/tableop_hooks.h

  • Committer: Monty Taylor
  • Date: 2008-11-04 18:01:26 UTC
  • mto: (575.1.7 fix-headers)
  • mto: This revision was merged to the branch mainline in revision 579.
  • Revision ID: monty@inaugust.com-20081104180126-88cfh3g4q1szu7us
Moved some stuff out of handler.h.

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/tableop_hooks.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
 *
 
6
 *  This program is free software; you can redistribute it and/or modify
 
7
 *  it under the terms of the GNU General Public License as published by
 
8
 *  the Free Software Foundation; version 2 of the License.
 
9
 *
 
10
 *  This program is distributed in the hope that it will be useful,
 
11
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
13
 *  GNU General Public License for more details.
 
14
 *
 
15
 *  You should have received a copy of the GNU General Public License
 
16
 *  along with this program; if not, write to the Free Software
 
17
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
18
 */
 
19
 
 
20
#ifndef DRIZZLED_TABLEOP_HOOKS_H
 
21
#define DRIZZLED_TABLEOP_HOOKS_H
 
22
 
 
23
#include CSTDINT_H
 
24
 
 
25
class Table;
 
26
 
 
27
/*
 
28
  Class for maintaining hooks used inside operations on tables such
 
29
  as: create table functions, delete table functions, and alter table
 
30
  functions.
 
31
 
 
32
  Class is using the Template Method pattern to separate the public
 
33
  usage interface from the private inheritance interface.  This
 
34
  imposes no overhead, since the public non-virtual function is small
 
35
  enough to be inlined.
 
36
 
 
37
  The hooks are usually used for functions that does several things,
 
38
  e.g., create_table_from_items(), which both create a table and lock
 
39
  it. */
 
40
 
 
41
class Tableop_hooks
 
42
{
 
43
public:
 
44
  Tableop_hooks() {}
 
45
  virtual ~Tableop_hooks() {}
 
46
 
 
47
  inline void prelock(Table **tables, uint32_t count)
 
48
  {
 
49
    do_prelock(tables, count);
 
50
  }
 
51
 
 
52
  inline int postlock(Table **tables, uint32_t count)
 
53
  {
 
54
    return do_postlock(tables, count);
 
55
  }
 
56
private:
 
57
 
 
58
  /* Function primitive that is called prior to locking tables */
 
59
  virtual void do_prelock(Table **tables, uint32_t count);
 
60
 
 
61
  /**
 
62
     Primitive called after tables are locked.
 
63
 
 
64
     If an error is returned, the tables will be unlocked and error
 
65
     handling start.
 
66
 
 
67
     @return Error code or zero.
 
68
   */
 
69
  virtual int do_postlock(Table **tables, uint32_t count);
 
70
 
 
71
};
 
72
 
 
73
#endif /* DRIZZLED_TABLEOP_HOOKS_H */