src/include/core/store.h

   1 /*
   2  * SysDB - src/include/core/store.h
   3  * Copyright (C) 2012 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_CORE_STORE_H
  29 #define SDB_CORE_STORE_H 1
  30
  31 #include "sysdb.h"
  32 #include "core/object.h"
  33 #include "utils/time.h"
  34 #include "utils/llist.h"
  35
  36 #include <stdio.h>
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 extern const sdb_type_t sdb_host_type;
  43 extern const sdb_type_t sdb_attribute_type;
  44 extern const sdb_type_t sdb_service_type;
  45
  46 typedef struct {
  47         sdb_object_t parent;
  48
  49         sdb_time_t last_update;
  50         char *name;
  51 } sdb_store_obj_t;
  52 #define SDB_STORE_OBJ_INIT(t) { SDB_OBJECT_TYPED_INIT(t), 0, NULL }
  53 #define SDB_STORE_OBJ(obj) ((sdb_store_obj_t *)(obj))
  54 #define SDB_CONST_STORE_OBJ(obj) ((const sdb_store_obj_t *)(obj))
  55
  56 typedef struct {
  57         sdb_store_obj_t parent;
  58
  59         char *hostname;
  60 } sdb_service_t;
  61 #define SDB_SVC_INIT { SDB_STORE_OBJ_INIT(sdb_service_type), NULL }
  62 #define SDB_SVC(obj) ((sdb_service_t *)(obj))
  63 #define SDB_CONST_SVC(obj) ((const sdb_service_t *)(obj))
  64
  65 typedef struct {
  66         sdb_store_obj_t parent;
  67
  68         char *attr_value;
  69         char *hostname;
  70 } sdb_attribute_t;
  71 #define SDB_ATTR_INIT { SDB_STORE_OBJ_INIT(sdb_attribute_type), NULL, NULL }
  72 #define SDB_ATTR(obj) ((sdb_attribute_t *)(obj))
  73 #define SDB_CONST_ATTR(obj) ((const sdb_attribute_t *)(obj))
  74
  75 typedef struct {
  76         sdb_store_obj_t parent;
  77
  78         sdb_llist_t *attributes;
  79         sdb_llist_t *services;
  80 } sdb_host_t;
  81 #define SDB_HOST_INIT { SDB_STORE_OBJ_INIT(sdb_host_type), NULL, NULL }
  82 #define SDB_HOST(obj) ((sdb_host_t *)(obj))
  83 #define SDB_CONST_HOST(obj) ((const sdb_host_t *)(obj))
  84
  85 /* shortcuts for accessing the sdb_store_obj_t attributes of inheriting
  86  * objects */
  87 #define _last_update parent.last_update
  88 #define _name parent.name
  89
  90 sdb_host_t *
  91 sdb_host_create(const char *name);
  92
  93 /*
  94  * sdb_store_host:
  95  * Add/update a host in the store. If the host, identified by its name,
  96  * already exists, it will be updated according to the specified 'host'
  97  * object. Else, a new entry will be created in the store. Any memory required
  98  * for storing the entry will be allocated an managed by the store itself. The
  99  * specified host-object will not be referenced or further accessed.
 100  *
 101  * Returns:
 102  *  - 0 on success
 103  *  - a positive value if the new entry is older than the currently stored
 104  *    entry (in this case, no update will happen)
 105  *  - a negative value on error
 106  */
 107 int
 108 sdb_store_host(const sdb_host_t *host);
 109
 110 const sdb_host_t *
 111 sdb_store_get_host(const char *name);
 112
 113 sdb_attribute_t *
 114 sdb_attribute_create(const char *hostname,
 115                 const char *name, const char *value);
 116
 117 /*
 118  * sdb_store_attribute:
 119  * Add/update a host's attribute in the store. If the attribute, identified by
 120  * its name, already exists for the specified host, it will be updated
 121  * according to the specified 'attr' object. If the referenced host does not
 122  * exist, an error will be reported. Else, a new entry will be created in the
 123  * store. Any memory required for storing the entry will be allocated and
 124  * managed by the store itself. The specified attribute-object will not be
 125  * referenced or further accessed.
 126  *
 127  * Returns:
 128  *  - 0 on success
 129  *  - a positive value if the new entry is older than the currently stored
 130  *    entry (in this case, no update will happen)
 131  *  - a negative value on error
 132  */
 133 int
 134 sdb_store_attribute(const sdb_attribute_t *attr);
 135
 136 sdb_service_t *
 137 sdb_service_create(const char *hostname, const char *name);
 138
 139 /*
 140  * sdb_store_service:
 141  * Add/update a store in the store. If the service, identified by its name,
 142  * already exists for the specified host, it will be updated according to the
 143  * specified 'service' object. If the referenced host does not exist, an error
 144  * will be reported. Else, a new entry will be created in the store. Any
 145  * memory required for storing the entry will be allocated an managed by the
 146  * store itself. The specified service-object will not be referenced or
 147  * further accessed.
 148  *
 149  * Returns:
 150  *  - 0 on success
 151  *  - a positive value if the new entry is older than the currently stored
 152  *    entry (in this case, no update will happen)
 153  *  - a negative value on error
 154  */
 155 int
 156 sdb_store_service(const sdb_service_t *svc);
 157
 158 const sdb_service_t *
 159 sdb_store_get_service(const sdb_host_t *host, const char *name);
 160
 161 int
 162 sdb_store_dump(FILE *fh);
 163
 164 #ifdef __cplusplus
 165 } /* extern "C" */
 166 #endif
 167
 168 #endif /* ! SDB_CORE_STORE_H */
 169
 170 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 171