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_IDLE = 0,
48 CONNECTION_PING,
49 CONNECTION_STARTUP,
50 } sdb_conn_state_t;
52 typedef struct sdb_conn sdb_conn_t;
54 /*
55 * sdb_connection_accpet:
56 * Accept a new connection on the specified file-descriptor 'fd' and return a
57 * newly allocated connection object.
58 *
59 * Returns:
60 * - 0 on success
61 * - a negative value else
62 */
63 sdb_conn_t *
64 sdb_connection_accept(int fd);
66 /*
67 * sdb_connection_close:
68 * Close a open connection and deallocate any memory. The connection object is
69 * no longer valid after calling this function.
70 */
71 void
72 sdb_connection_close(sdb_conn_t *conn);
74 /*
75 * sdb_connection_read:
76 * Read from an open connection until reading would block.
77 *
78 * Returns:
79 * - the number of bytes read (0 on EOF)
80 * - a negative value on error
81 */
82 ssize_t
83 sdb_connection_read(sdb_conn_t *conn);
85 /*
86 * sdb_connection_send:
87 * Send to an open connection.
88 *
89 * Returns:
90 * - the number of bytes written
91 * - a negative value on error
92 */
93 ssize_t
94 sdb_connection_send(sdb_conn_t *conn, uint32_t code,
95 uint32_t msg_len, char *msg);
97 /*
98 * sdb_connection_ping:
99 * Send back a backend status indicator to the connected client.
100 *
101 * Returns:
102 * - 0 on success
103 * - a negative value else
104 */
105 int
106 sdb_connection_ping(sdb_conn_t *conn);
108 /*
109 * session handling
110 */
112 /*
113 * sdb_session_start:
114 * Start a new user session on the specified connection.
115 *
116 * Returns:
117 * - 0 on success
118 * - a negative value else
119 */
120 int
121 sdb_session_start(sdb_conn_t *conn);
123 #ifdef __cplusplus
124 } /* extern "C" */
125 #endif
127 #endif /* ! SDB_FRONTEND_CONNECTION_H */
129 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */