merge status code changes from samba4 ctdb
[vlendec/samba-autobuild/.git] / ctdb / include / ctdb.h
1 /* 
2    ctdb database library
3
4    Copyright (C) Andrew Tridgell  2006
5
6    This library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2 of the License, or (at your option) any later version.
10
11    This library 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 GNU
14    Lesser General Public License for more details.
15
16    You should have received a copy of the GNU Lesser General Public
17    License along with this library; if not, write to the Free Software
18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19 */
20
21 #ifndef _CTDB_H
22 #define _CTDB_H
23
24 struct ctdb_call {
25         int call_id;
26         TDB_DATA key;
27         TDB_DATA call_data;
28         TDB_DATA reply_data;
29         uint32_t status;
30 };
31
32 /*
33   structure passed to a ctdb call backend function
34 */
35 struct ctdb_call_info {
36         TDB_DATA key;          /* record key */
37         TDB_DATA record_data;  /* current data in the record */
38         TDB_DATA *new_data;    /* optionally updated record data */
39         TDB_DATA *call_data;   /* optionally passed from caller */
40         TDB_DATA *reply_data;  /* optionally returned by function */
41         uint32_t status;       /* optional reply status - defaults to zero */
42 };
43
44 #define CTDB_ERR_INVALID 1
45 #define CTDB_ERR_NOMEM 2
46
47 /*
48   ctdb flags
49 */
50 #define CTDB_FLAG_SELF_CONNECT (1<<0)
51
52
53 struct event_context;
54
55 /*
56   initialise ctdb subsystem
57 */
58 struct ctdb_context *ctdb_init(struct event_context *ev);
59
60 /*
61   choose the transport
62 */
63 int ctdb_set_transport(struct ctdb_context *ctdb, const char *transport);
64
65 /*
66   set some flags
67 */
68 void ctdb_set_flags(struct ctdb_context *ctdb, unsigned flags);
69
70 /*
71   set max acess count before a dmaster migration
72 */
73 void ctdb_set_max_lacount(struct ctdb_context *ctdb, unsigned count);
74
75 /*
76   tell ctdb what address to listen on, in transport specific format
77 */
78 int ctdb_set_address(struct ctdb_context *ctdb, const char *address);
79
80 /*
81   tell ctdb what nodes are available. This takes a filename, which will contain
82   1 node address per line, in a transport specific format
83 */
84 int ctdb_set_nlist(struct ctdb_context *ctdb, const char *nlist);
85
86 /*
87   start the ctdb protocol
88 */
89 int ctdb_start(struct ctdb_context *ctdb);
90
91 /*
92   error string for last ctdb error
93 */
94 const char *ctdb_errstr(struct ctdb_context *);
95
96 /* a ctdb call function */
97 typedef int (*ctdb_fn_t)(struct ctdb_call_info *);
98
99 /*
100   setup a ctdb call function
101 */
102 int ctdb_set_call(struct ctdb_context *ctdb, ctdb_fn_t fn, int id);
103
104 /*
105   attach to a ctdb database
106 */
107 int ctdb_attach(struct ctdb_context *ctdb, const char *name, int tdb_flags, 
108                 int open_flags, mode_t mode);
109
110
111 /*
112   make a ctdb call. The associated ctdb call function will be called on the DMASTER
113   for the given record
114 */
115 int ctdb_call(struct ctdb_context *ctdb, struct ctdb_call *call);
116
117 /*
118   wait for all nodes to be connected - useful for test code
119 */
120 void ctdb_connect_wait(struct ctdb_context *ctdb);
121
122 /*
123   wait until we're the only node left
124 */
125 void ctdb_wait_loop(struct ctdb_context *ctdb);
126
127 /* return vnn of this node */
128 uint32_t ctdb_get_vnn(struct ctdb_context *ctdb);
129
130 #endif