common/server.h

   1 /******************************************************************************/
   2 /*          pfixtools: a collection of postfix related tools                  */
   3 /*          ~~~~~~~~~                                                         */
   4 /*  ________________________________________________________________________  */
   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 /*                                                                            */
  10 /*  1. Redistributions of source code must retain the above copyright         */
  11 /*     notice, this list of conditions and the following disclaimer.          */
  12 /*  2. Redistributions in binary form must reproduce the above copyright      */
  13 /*     notice, this list of conditions and the following disclaimer in the    */
  14 /*     documentation and/or other materials provided with the distribution.   */
  15 /*  3. The names of its contributors may not be used to endorse or promote    */
  16 /*     products derived from this software without specific prior written     */
  17 /*     permission.                                                            */
  18 /*                                                                            */
  19 /*  THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``AS IS'' AND ANY EXPRESS   */
  20 /*  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED         */
  21 /*  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE    */
  22 /*  DISCLAIMED.  IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY         */
  23 /*  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL        */
  24 /*  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS   */
  25 /*  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)     */
  26 /*  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,       */
  27 /*  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN  */
  28 /*  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE           */
  29 /*  POSSIBILITY OF SUCH DAMAGE.                                               */
  30 /*                                                                            */
  31 /*   Copyright (c) 2006-2008 the Authors                                      */
  32 /*   see AUTHORS and source files for details                                 */
  33 /******************************************************************************/
  34
  35 /*
  36  * Copyright © 2008 Florent Bruneau
  37  */
  38
  39 #ifndef PFIXTOOLS_SERVER_H
  40 #define PFIXTOOLS_SERVER_H
  41
  42 #include "buffer.h"
  43
  44 typedef struct client_t client_t;
  45 typedef struct listener_t listener_t;
  46 PARRAY(client_t)
  47 PARRAY(listener_t)
  48
  49 typedef void *(*start_listener_t)(void);
  50 typedef void  (*delete_client_t)(void*);
  51 typedef void *(*start_client_t)(listener_t*);
  52 typedef int   (*run_client_t)(client_t*, void*);
  53 typedef bool    (*refresh_t)(void*);
  54
  55
  56 listener_t *start_listener(int port);
  57
  58 client_t *client_register(int fd, run_client_t runner, void *data);
  59 void client_delete(client_t **client);
  60 void client_release(client_t *client);
  61
  62 void client_io_none(client_t *client);
  63 void client_io_rw(client_t *client);
  64 void client_io_ro(client_t *client);
  65
  66 ssize_t client_read(client_t *client);
  67 buffer_t *client_input_buffer(client_t *client);
  68 buffer_t *client_output_buffer(client_t *client);
  69 void *client_data(client_t *client);
  70
  71 int server_loop(start_client_t starter, delete_client_t deleter,
  72                 run_client_t runner, refresh_t refresh, void *config);
  73
  74 #endif