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