1 /*
2 * SysDB - src/include/frontend/connection.h
3 * Copyright (C) 2013 Sebastian 'tokkee' Harl <sh@tokkee.org>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
19 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
28 #ifndef SDB_FRONTEND_CONNECTION_H
29 #define SDB_FRONTEND_CONNECTION_H 1
31 #include "utils/strbuf.h"
33 #include <inttypes.h>
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
39 /* status codes returned to a client */
40 typedef enum {
41 CONNECTION_OK = 0,
42 CONNECTION_ERROR
43 } sdb_conn_status_t;
45 /* accepted commands / state of the connection */
46 typedef enum {
47 /* connection handling */
48 CONNECTION_IDLE = 0,
49 CONNECTION_PING,
50 CONNECTION_STARTUP,
52 /* querying */
53 CONNECTION_LIST,
54 } sdb_conn_state_t;
56 typedef struct sdb_conn sdb_conn_t;
58 /*
59 * sdb_connection_accpet:
60 * Accept a new connection on the specified file-descriptor 'fd' and return a
61 * newly allocated connection object.
62 *
63 * Returns:
64 * - 0 on success
65 * - a negative value else
66 */
67 sdb_conn_t *
68 sdb_connection_accept(int fd);
70 /*
71 * sdb_connection_close:
72 * Close a open connection and deallocate any memory. The connection object is
73 * no longer valid after calling this function.
74 */
75 void
76 sdb_connection_close(sdb_conn_t *conn);
78 /*
79 * sdb_connection_read:
80 * Read from an open connection until reading would block.
81 *
82 * Returns:
83 * - the number of bytes read (0 on EOF)
84 * - a negative value on error
85 */
86 ssize_t
87 sdb_connection_read(sdb_conn_t *conn);
89 /*
90 * sdb_connection_send:
91 * Send to an open connection.
92 *
93 * Returns:
94 * - the number of bytes written
95 * - a negative value on error
96 */
97 ssize_t
98 sdb_connection_send(sdb_conn_t *conn, uint32_t code,
99 uint32_t msg_len, const char *msg);
101 /*
102 * sdb_connection_ping:
103 * Send back a backend status indicator to the connected client.
104 *
105 * Returns:
106 * - 0 on success
107 * - a negative value else
108 */
109 int
110 sdb_connection_ping(sdb_conn_t *conn);
112 /*
113 * session handling
114 */
116 /*
117 * sdb_fe_session_start:
118 * Start a new user session on the specified connection.
119 *
120 * Returns:
121 * - 0 on success
122 * - a negative value else
123 */
124 int
125 sdb_fe_session_start(sdb_conn_t *conn);
127 /*
128 * store access
129 */
131 /*
132 * sdb_fe_list:
133 * Send a complete listing of the store, serialized as JSON, to the client.
134 *
135 * Returns:
136 * - 0 on success
137 * - a negative value else
138 */
139 int
140 sdb_fe_list(sdb_conn_t *conn);
142 #ifdef __cplusplus
143 } /* extern "C" */
144 #endif
146 #endif /* ! SDB_FRONTEND_CONNECTION_H */
148 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */