src/frontend/connection-private.h

   1 /*
   2  * SysDB - src/frontend/connection-private.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 /*
  29  * private data structures used by frontend modules
  30  */
  31
  32 #ifndef SDB_FRONTEND_CONNECTION_PRIVATE_H
  33 #define SDB_FRONTEND_CONNECTION_PRIVATE_H 1
  34
  35 #include "frontend/connection.h"
  36
  37 #include "core/object.h"
  38 #include "core/timeseries.h"
  39 #include "utils/ssl.h"
  40 #include "utils/strbuf.h"
  41
  42 #include <inttypes.h>
  43 #include <arpa/inet.h>
  44
  45 #include <stdlib.h>
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 struct sdb_conn {
  52         sdb_object_t super;
  53
  54         /* file-descriptor of the open connection */
  55         int fd;
  56
  57         /* connection and client information */
  58         struct sockaddr_storage client_addr;
  59         socklen_t client_addr_len;
  60
  61         /* connection handling */
  62         ssize_t (*read)(sdb_conn_t *, size_t);
  63         ssize_t (*write)(sdb_conn_t *, const void *, size_t);
  64         int (*finish)(sdb_conn_t *);
  65         sdb_ssl_session_t *ssl_session;
  66
  67         /* read buffer */
  68         sdb_strbuf_t *buf;
  69
  70         /* connection / protocol state information */
  71         uint32_t cmd;
  72         uint32_t cmd_len;
  73
  74         /* amount of data to skip, e.g., after receiving invalid commands; if this
  75          * is non-zero, the 'skip_len' first bytes of 'buf' are invalid */
  76         size_t skip_len;
  77
  78         sdb_strbuf_t *errbuf;
  79
  80         /* user information */
  81         char *username; /* NULL if the user has not been authenticated */
  82         bool  ready; /* indicates that startup finished successfully */
  83 };
  84 #define CONN(obj) ((sdb_conn_t *)(obj))
  85
  86 #ifdef __cplusplus
  87 } /* extern "C" */
  88 #endif
  89
  90 #endif /* ! SDB_FRONTEND_CONNECTION_H */
  91
  92 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
  93