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
|
/*
* Copyright (C) 2005-2015 Christoph Rupp (chris@crupp.de).
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef HAM_HAMSTERDB_SRV_H
#define HAM_HAMSTERDB_SRV_H
#ifdef __cplusplus
extern "C" {
#endif
#include <ham/hamsterdb.h>
/**
* @defgroup ham_server hamsterdb Embedded Server
* @{
*/
/**
* A configuration structure
*
* It is always recommended to initialize the full structure with zeroes
* before using it.
*/
typedef struct {
/** The server port */
uint16_t port;
/* Path of the access log, or NULL if no log should be written
* - currently NOT USED! */
const char *access_log_path;
/** Path of the error log, or NULL if no log should be written
* - currently NOT USED! */
const char *error_log_path;
} ham_srv_config_t;
/**
* A server handle
*/
struct ham_srv_t;
typedef struct ham_srv_t ham_srv_t;
/**
* Initialize the server
*
* This function initializes a ham_srv_t handle and starts the hamsterdb
* database server on the port specified in the configuration object.
*
* @param config A configuration structure
* @param srv A pointer to a ham_srv_t pointer; will be allocated
* if this function returns successfully
*
* @return HAM_SUCCESS on success
* @return HAM_OUT_OF_MEMORY if memory could not be allocated
*/
extern ham_status_t
ham_srv_init(ham_srv_config_t *config, ham_srv_t **srv);
/**
* Add a hamsterdb Environment
*
* This function adds a new hamsterdb Environment to the server. The
* Environment has to be initialized properly by the caller. It will be
* served at ham://localhost:port/urlname, where @a port was specified
* for @ref ham_srv_init and @a urlname is the third parameter to this
* function.
*
* A client accessing this Environment will specify this URL as a filename,
* and hamsterdb will transparently connect to this server.
*
* @param srv A valid ham_srv_t handle
* @param env A valid hamsterdb Environment handle
* @param urlname URL of this Environment
*
* @return HAM_SUCCESS on success
* @return HAM_LIMITS_REACHED if more than the max. number of Environments
* were added (default limit: 128)
*/
extern ham_status_t
ham_srv_add_env(ham_srv_t *srv, ham_env_t *env, const char *urlname);
/*
* Release memory and clean up
*
* @param srv A valid ham_srv_t handle
*
* @warning
* This function will not close open handles (i.e. of Databases, Cursors
* or Transactions). The caller has to close the remaining Environment
* handles (@see ham_env_close).
*/
extern void
ham_srv_close(ham_srv_t *srv);
/**
* @}
*/
#ifdef __cplusplus
} // extern "C"
#endif
#endif /* HAM_HAMSTERDB_SRV_H */
|
