utils data: Added module providing a data-type to store arbitrary backend data

[sysdb.git] / src / include / utils / data.h

diff --git a/src/include/utils/data.h b/src/include/utils/data.h
new file mode 100644 (file)
index 0000000..a18d658
--- /dev/null
+++ b/src/include/utils/data.h
@@ -0,0 +1,77 @@
+/*
+ * syscollector - src/include/utils/data.h
+ * Copyright (C) 2012 Sebastian 'tokkee' Harl <sh@tokkee.org>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+ * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+ * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef SC_UTILS_DATA_H
+#define SC_UTILS_DATA_H 1
+
+#include "utils/time.h"
+
+#include <inttypes.h>
+#include <stddef.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+enum {
+       SC_TYPE_INTEGER = 1,
+       SC_TYPE_DECIMAL,
+       SC_TYPE_STRING,
+       SC_TYPE_DATETIME,
+       SC_TYPE_BINARY,
+};
+
+/*
+ * sc_data_t:
+ * A datum retrieved from an arbitrary data source.
+ *
+ * The string and binary objects are managed by whoever creates the data
+ * object, thus, they must not be freed or modified. If you want to keep them,
+ * make sure to make a copy.
+ */
+typedef struct {
+       int type;
+       union {
+               int64_t     integer;  /* SC_TYPE_INTEGER */
+               double      decimal;  /* SC_TYPE_DECIMAL */
+               const char *string;   /* SC_TYPE_STRING  */
+               sc_time_t   datetime; /* SC_TYPE_DATETIME */
+               struct {
+                       size_t length;
+                       const unsigned char *datum;
+               } binary;             /* SC_TYPE_BINARY */
+       } data;
+} sc_data_t;
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
+#endif /* ! SC_UTILS_DATA_H */
+
+/* vim: set tw=78 sw=4 ts=4 noexpandtab : */
+