1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
/**
* Copyright (C) 2017 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects
* for all of the code used other than as permitted herein. If you modify
* file(s) with this exception, you may extend this exception to your
* version of the file(s), but you are not obligated to do so. If you do not
* wish to do so, delete this exception statement from your version. If you
* delete this exception statement from all source files in the program,
* then also delete it in the license file.
*/
#ifndef LIBMONGODBCAPI_H
#define LIBMONGODBCAPI_H
#include <stddef.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct libmongodbcapi_db libmongodbcapi_db;
typedef struct libmongodbcapi_client libmongodbcapi_client;
typedef enum {
LIBMONGODB_CAPI_ERROR_UNKNOWN = -1,
LIBMONGODB_CAPI_SUCCESS = 0,
LIBMONGODB_CAPI_ERROR_LIBRARY_ALREADY_INITIALIZED,
LIBMONGODB_CAPI_ERROR_LIBRARY_NOT_INITIALIZED,
LIBMONGODB_CAPI_ERROR_DB_OPEN,
} libmongodbcapi_error;
/**
* Initializes the mongodbcapi library, required before any other call. Cannot be called again
* without libmongodbcapi_fini() being called first.
*
* @param config null-terminated YAML formatted MongoDB configuration. See documentation for valid
* options.
*
* @note This function is not thread safe.
*
* @return Returns LIBMONGODB_CAPI_SUCCESS on success.
* @return Returns LIBMONGODB_CAPI_ERROR_LIBRARY_ALREADY_INITIALIZED if libmongodbcapi_init() has
* already been called without an intervening call to libmongodbcapi_fini().
*/
int libmongodbcapi_init(const char* yaml_config);
/**
* Tears down the state of the library, all databases must be closed before calling this.
*
* @note This function is not thread safe.
*
* @return Returns LIBMONGODB_CAPI_SUCCESS on success.
* @return Returns LIBMONGODB_CAPI_ERROR_LIBRARY_NOT_INITIALIZED if libmongodbcapi_init() has not
* been called previously.
* @return Returns LIBMONGODB_CAPI_ERROR_DB_OPEN if there are open databases that haven't been closed
* with libmongodbcapi_db_destroy().
* @return Returns LIBMONGODB_CAPI_ERROR_UNKNOWN for any other unspecified errors.
*/
int libmongodbcapi_fini();
/**
* Starts the database and returns a handle with the service context.
*
* @param argc
* The number of arguments in argv
* @param argv
* The arguments that will be passed to mongod at startup to initialize state
* @param envp
* Environment variables that will be passed to mongod at startup to initilize state
*
* @return A pointer to a db handle or null on error
*/
libmongodbcapi_db* libmongodbcapi_db_new(int argc, const char** argv, const char** envp);
/**
* Shuts down the database
*
* @param
* A pointer to a db handle to be destroyed
*
* @return A libmongo error code
*/
int libmongodbcapi_db_destroy(libmongodbcapi_db* db);
/**
* Let the database do background work. Returns an int from the error enum
*
* @param
* The database that has work that needs to be done
*
* @return Returns LIBMONGODB_CAPI_SUCCESS on success, or an error code from libmongodbcapi_error on
* failure.
*/
int libmongodbcapi_db_pump(libmongodbcapi_db* db);
/**
* Creates a new clienst and retuns it so the caller can do operation
* A client will be destroyed when the owning db is destroyed
*
* @param db
* The datadase that will own this client and execute its RPC calls
*
* @return A pointer to a client or null on error
*/
libmongodbcapi_client* libmongodbcapi_db_client_new(libmongodbcapi_db* db);
/**
* Destroys a client and removes it from the db/service context
* Cannot be called after the owning db is destroyed
*
* @param client
* A pointer to the client to be destroyed
*/
void libmongodbcapi_db_client_destroy(libmongodbcapi_client* client);
/**
* Makes an RPC call to the database
*
* @param client
* The client that will be performing the query on the database
* @param input
* The query to be sent to and then executed by the database
* @param input_size
* The size (number of bytes) of the input query
* @param output
* A pointer to a void * where the database can write the location of the output.
* The library will manage the memory pointer to by *output.
* @TODO document lifetime of this buffer
* @param output_size
* A pointer to a location where this function will write the size (number of bytes)
* of the output
*
* @return Returns LIBMONGODB_CAPI_SUCCESS on success, or an error code from libmongodbcapi_error on
* failure.
*/
int libmongodbcapi_db_client_wire_protocol_rpc(libmongodbcapi_client* client,
const void* input,
size_t input_size,
void** output,
size_t* output_size);
/**
* @return a per-thread value indicating the last error
*/
int libmongodbcapi_get_last_error();
#ifdef __cplusplus
}
#endif
#endif
|
