src/include/frontend/connection.h

   1 /*
   2  * SysDB - src/include/frontend/connection.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_CONNECTION_H
  29 #define SDB_FRONTEND_CONNECTION_H 1
  30
  31 #include "utils/strbuf.h"
  32
  33 #include <inttypes.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 /* a generic connection object */
  40 typedef struct {
  41         /* file-descriptor of the open connection */
  42         int fd;
  43
  44         /* read buffer */
  45         sdb_strbuf_t *buf;
  46
  47         /* connection / protocol state information */
  48         uint32_t cmd;
  49         uint32_t cmd_len;
  50 } sdb_conn_t;
  51
  52 /*
  53  * sdb_connection_read:
  54  * Read from an open connection until reading would block.
  55  *
  56  * Returns:
  57  *  - the number of bytes read (0 on EOF)
  58  *  - a negative value on error
  59  */
  60 ssize_t
  61 sdb_connection_read(sdb_conn_t *conn);
  62
  63 #ifdef __cplusplus
  64 } /* extern "C" */
  65 #endif
  66
  67 #endif /* ! SDB_FRONTEND_CONNECTION_H */
  68
  69 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
  70