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 /*
  36  * sdb_fe_socket_t:
  37  * A front-end socket accepting connections from clients.
  38  */
  39 typedef struct sdb_fe_socket sdb_fe_socket_t;
  40
  41 /*
  42  * sdb_fe_sock_create:
  43  * Create a socket object.
  44  *
  45  * Returns:
  46  *  - a socket object on success
  47  *  - NULL else
  48  */
  49 sdb_fe_socket_t *
  50 sdb_fe_sock_create(void);
  51
  52 /*
  53  * sdb_fe_sock_destroy:
  54  * Shut down all listeners and destroy a socket object.
  55  */
  56 void
  57 sdb_fe_sock_destroy(sdb_fe_socket_t *sock);
  58
  59 /*
  60  * sdb_fe_sock_add_listener:
  61  * Tell the specified socket to listen on the specified 'address'.
  62  * The address has to be specified as <type>:<address> where the following
  63  * types are currently supported:
  64  *
  65  *  - unix: listen on a UNIX socket
  66  *
  67  * Returns:
  68  *  - 0 on success
  69  *  - a negative value else
  70  */
  71 int
  72 sdb_fe_sock_add_listener(sdb_fe_socket_t *sock, const char *address);
  73
  74 /*
  75  * sdb_fe_sock_listen_and_serve:
  76  * Listen on the specified socket and serve client requests.
  77  *
  78  * Returns:
  79  *  - 0 on success
  80  *  - a negative value else
  81  */
  82 int
  83 sdb_fe_sock_listen_and_serve(sdb_fe_socket_t *sock);
  84
  85 #ifdef __cplusplus
  86 } /* extern "C" */
  87 #endif
  88
  89 #endif /* ! SDB_FRONTEND_SOCK_H */
  90
  91 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
  92