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