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 /* a generic connection object */
53 typedef struct {
54 /* file-descriptor of the open connection */
55 int fd;
57 /* read buffer */
58 sdb_strbuf_t *buf;
60 /* connection / protocol state information */
61 uint32_t cmd;
62 uint32_t cmd_len;
64 /* user information */
65 char *username; /* NULL if the user has not been authenticated */
66 } sdb_conn_t;
68 /*
69 * sdb_connection_init:
70 * Initialize an (already allocated) connection. This function allocates and
71 * initialized any attributes. It's an error to call init on an already
72 * initialized object.
73 *
74 * Returns:
75 * - 0 on success
76 * - a negative value else
77 */
78 int
79 sdb_connection_init(sdb_conn_t *conn);
81 /*
82 * sdb_connection_close:
83 * Close a open connection and deallocate any memory used by its attributes.
84 */
85 void
86 sdb_connection_close(sdb_conn_t *conn);
88 /*
89 * sdb_connection_read:
90 * Read from an open connection until reading would block.
91 *
92 * Returns:
93 * - the number of bytes read (0 on EOF)
94 * - a negative value on error
95 */
96 ssize_t
97 sdb_connection_read(sdb_conn_t *conn);
99 /*
100 * sdb_connection_send:
101 * Send to an open connection.
102 *
103 * Returns:
104 * - the number of bytes written
105 * - a negative value on error
106 */
107 ssize_t
108 sdb_connection_send(sdb_conn_t *conn, uint32_t code,
109 uint32_t msg_len, char *msg);
111 /*
112 * sdb_connection_ping:
113 * Send back a backend status indicator to the connected client.
114 *
115 * Returns:
116 * - 0 on success
117 * - a negative value else
118 */
119 int
120 sdb_connection_ping(sdb_conn_t *conn);
122 /*
123 * session handling
124 */
126 /*
127 * sdb_session_start:
128 * Start a new user session on the specified connection.
129 *
130 * Returns:
131 * - 0 on success
132 * - a negative value else
133 */
134 int
135 sdb_session_start(sdb_conn_t *conn);
137 #ifdef __cplusplus
138 } /* extern "C" */
139 #endif
141 #endif /* ! SDB_FRONTEND_CONNECTION_H */
143 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */