src/include/frontend/sock.h

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