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 "frontend/proto.h"
  32 #include "utils/strbuf.h"
  33
  34 #include <inttypes.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 typedef struct sdb_conn sdb_conn_t;
  41
  42 /*
  43  * sdb_connection_accpet:
  44  * Accept a new connection on the specified file-descriptor 'fd' and return a
  45  * newly allocated connection object.
  46  *
  47  * Returns:
  48  *  - 0 on success
  49  *  - a negative value else
  50  */
  51 sdb_conn_t *
  52 sdb_connection_accept(int fd);
  53
  54 /*
  55  * sdb_connection_close:
  56  * Close a open connection and deallocate any memory. The connection object is
  57  * no longer valid after calling this function.
  58  */
  59 void
  60 sdb_connection_close(sdb_conn_t *conn);
  61
  62 /*
  63  * sdb_connection_read:
  64  * Read from an open connection until reading would block.
  65  *
  66  * Returns:
  67  *  - the number of bytes read (0 on EOF)
  68  *  - a negative value on error
  69  */
  70 ssize_t
  71 sdb_connection_read(sdb_conn_t *conn);
  72
  73 /*
  74  * sdb_connection_send:
  75  * Send to an open connection.
  76  *
  77  * Returns:
  78  *  - the number of bytes written
  79  *  - a negative value on error
  80  */
  81 ssize_t
  82 sdb_connection_send(sdb_conn_t *conn, uint32_t code,
  83                 uint32_t msg_len, const char *msg);
  84
  85 /*
  86  * sdb_connection_ping:
  87  * Send back a backend status indicator to the connected client.
  88  *
  89  * Returns:
  90  *  - 0 on success
  91  *  - a negative value else
  92  */
  93 int
  94 sdb_connection_ping(sdb_conn_t *conn);
  95
  96 /*
  97  * sdb_fe_parse:
  98  * Parse the query text specified in 'query'.
  99  */
 100 int
 101 sdb_fe_parse(const char *query);
 102
 103 /*
 104  * session handling
 105  */
 106
 107 /*
 108  * sdb_fe_session_start:
 109  * Start a new user session on the specified connection.
 110  *
 111  * Returns:
 112  *  - 0 on success
 113  *  - a negative value else
 114  */
 115 int
 116 sdb_fe_session_start(sdb_conn_t *conn);
 117
 118 /*
 119  * store access
 120  */
 121
 122 /*
 123  * sdb_fe_list:
 124  * Send a complete listing of the store, serialized as JSON, to the client.
 125  *
 126  * Returns:
 127  *  - 0 on success
 128  *  - a negative value else
 129  */
 130 int
 131 sdb_fe_list(sdb_conn_t *conn);
 132
 133 #ifdef __cplusplus
 134 } /* extern "C" */
 135 #endif
 136
 137 #endif /* ! SDB_FRONTEND_CONNECTION_H */
 138
 139 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 140