1 /*
2 * SysDB - src/include/frontend/sock.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 #include <stdbool.h>
29 #include <unistd.h>
31 #ifndef SDB_FRONTEND_SOCK_H
32 #define SDB_FRONTEND_SOCK_H 1
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
38 /* manage a front-end listener loop */
39 typedef struct {
40 /* number of handler threads to create */
41 size_t num_threads;
43 /* front-end listener shuts down when this is set to false */
44 bool do_loop;
45 } sdb_fe_loop_t;
46 #define SDB_FE_LOOP_INIT { 5, 1 }
48 /*
49 * sdb_fe_socket_t:
50 * A front-end socket accepting connections from clients.
51 */
52 typedef struct sdb_fe_socket sdb_fe_socket_t;
54 /*
55 * sdb_fe_sock_create:
56 * Create a socket object.
57 *
58 * Returns:
59 * - a socket object on success
60 * - NULL else
61 */
62 sdb_fe_socket_t *
63 sdb_fe_sock_create(void);
65 /*
66 * sdb_fe_sock_destroy:
67 * Shut down all listeners and destroy a socket object.
68 */
69 void
70 sdb_fe_sock_destroy(sdb_fe_socket_t *sock);
72 /*
73 * sdb_fe_sock_add_listener:
74 * Tell the specified socket to listen on the specified 'address'.
75 * The address has to be specified as <type>:<address> where the following
76 * types are currently supported:
77 *
78 * - unix: listen on a UNIX socket
79 *
80 * Returns:
81 * - 0 on success
82 * - a negative value else
83 */
84 int
85 sdb_fe_sock_add_listener(sdb_fe_socket_t *sock, const char *address);
87 /*
88 * sdb_fe_sock_clear_listeners:
89 * Shut down all listeners from the socket object and clear the list of
90 * listeners. All open connections will not be affected by this.
91 */
92 void
93 sdb_fe_sock_clear_listeners(sdb_fe_socket_t *sock);
95 /*
96 * sdb_fe_sock_listen_and_serve:
97 * Listen on the specified socket and serve client requests. The loop
98 * terminates on error or when the loop condition turns to false. All
99 * listening sockets will be closed at that time.
100 *
101 * Returns:
102 * - 0 on success
103 * - a negative value else
104 */
105 int
106 sdb_fe_sock_listen_and_serve(sdb_fe_socket_t *sock, sdb_fe_loop_t *loop);
108 #ifdef __cplusplus
109 } /* extern "C" */
110 #endif
112 #endif /* ! SDB_FRONTEND_SOCK_H */
114 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */