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