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/store.h"
  39 #include "utils/strbuf.h"
  40
  41 #include <inttypes.h>
  42 #include <arpa/inet.h>
  43
  44 #include <stdlib.h>
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 struct sdb_conn {
  51         sdb_object_t super;
  52
  53         /* file-descriptor of the open connection */
  54         int fd;
  55
  56         /* connection and client information */
  57         struct sockaddr_storage client_addr;
  58         socklen_t client_addr_len;
  59
  60         /* read buffer */
  61         sdb_strbuf_t *buf;
  62
  63         /* connection / protocol state information */
  64         uint32_t cmd;
  65         uint32_t cmd_len;
  66
  67         /* amount of data to skip, e.g., after receiving invalid commands; if this
  68          * is non-zero, the 'skip_len' first bytes of 'buf' are invalid */
  69         size_t skip_len;
  70
  71         sdb_strbuf_t *errbuf;
  72
  73         /* user information */
  74         char *username; /* NULL if the user has not been authenticated */
  75 };
  76 #define CONN(obj) ((sdb_conn_t *)(obj))
  77
  78 /*
  79  * node types
  80  */
  81
  82 typedef struct {
  83         sdb_conn_node_t super;
  84         sdb_store_matcher_t *matcher;
  85 } conn_matcher_t;
  86 #define CONN_MATCHER(obj) ((conn_matcher_t *)(obj))
  87
  88 typedef struct {
  89         sdb_conn_node_t super;
  90         conn_matcher_t *filter;
  91 } conn_list_t;
  92 #define CONN_LIST(obj) ((conn_list_t *)(obj))
  93
  94 typedef struct {
  95         sdb_conn_node_t super;
  96         char *name;
  97         conn_matcher_t *filter;
  98 } conn_fetch_t;
  99 #define CONN_FETCH(obj) ((conn_fetch_t *)(obj))
 100
 101 typedef struct {
 102         sdb_conn_node_t super;
 103         conn_matcher_t *matcher;
 104         conn_matcher_t *filter;
 105 } conn_lookup_t;
 106 #define CONN_LOOKUP(obj) ((conn_lookup_t *)(obj))
 107
 108 /*
 109  * type helper functions
 110  */
 111
 112 static void __attribute__((unused))
 113 conn_matcher_destroy(sdb_object_t *obj)
 114 {
 115         sdb_object_deref(SDB_OBJ(CONN_MATCHER(obj)->matcher));
 116 } /* conn_matcher_destroy */
 117
 118 static void __attribute__((unused))
 119 conn_list_destroy(sdb_object_t *obj)
 120 {
 121         sdb_object_deref(SDB_OBJ(CONN_LIST(obj)->filter));
 122 } /* conn_list_destroy */
 123
 124 static void __attribute__((unused))
 125 conn_fetch_destroy(sdb_object_t *obj)
 126 {
 127         if (CONN_FETCH(obj)->name)
 128                 free(CONN_FETCH(obj)->name);
 129         sdb_object_deref(SDB_OBJ(CONN_FETCH(obj)->filter));
 130 } /* conn_fetch_destroy */
 131
 132 static void __attribute__((unused))
 133 conn_lookup_destroy(sdb_object_t *obj)
 134 {
 135         sdb_object_deref(SDB_OBJ(CONN_LOOKUP(obj)->matcher));
 136         sdb_object_deref(SDB_OBJ(CONN_LOOKUP(obj)->filter));
 137 } /* conn_lookup_destroy */
 138
 139 #ifdef __cplusplus
 140 } /* extern "C" */
 141 #endif
 142
 143 #endif /* ! SDB_FRONTEND_CONNECTION_H */
 144
 145 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 146