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