1 files changed, 117 insertions, 0 deletions
diff --git a/common/elapi/elapi_log.h b/common/elapi/elapi_log.h
new file mode 100644
index 00000000..6fff82b6
--- /dev/null
+++ b/common/elapi/elapi_log.h
@@ -0,0 +1,117 @@
+/*
+    ELAPI
+
+    Header file for the ELAPI logging interface.
+
+    Copyright (C) Dmitri Pal <dpal@redhat.com> 2009
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 3 of the License, or
+    (at your option) any later version.
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef ELAPI_LOG_H
+#define ELAPI_LOG_H
+
+#include "elapi_async.h"
+
+/* Opaque dispatcher structure */
+struct elapi_dispatcher;
+
+
+/******************** Low level thread safe interface ************************************/
+/* This interface should be used if application plans to control the dispatcher,
+ * implement its own sinks that can be added dynamically or implements it own routing function.
+ */
+
+/********** Main functions of the interface **********/
+
+/* Function to create a dispatcher */
+int elapi_create_dispatcher(struct elapi_dispatcher **dispatcher,  /* Handle of the dispatcher will be stored in this variable */
+                            const char *appname,                   /* Application name. Passed to the sinks to do initialization */
+                            const char *config_path);              /* See notes below in the elapi_init() function. */
+
+/* A more advanced function to create a dispatcher */
+int elapi_create_dispatcher_adv(struct elapi_dispatcher **dispatcher,  /* Handle of the dispatcher will be stored in this variable */
+                                const char *appname,                   /* Application name. Passed to the sinks to do initialization */
+                                const char *config_path,               /* See notes below in the elapi_init() function. */
+                                elapi_add_fd add_fd_add_fn,            /* Caller's function to add file descriptor */
+                                elapi_rem_fd add_fd_rem_fn,            /* Caller's function to remove file descriptor */
+                                elapi_add_timer add_timer_fn,          /* Caller's function to add timer */
+                                void *callers_data);                   /* Data that needs to be passed when caller's callback is called. */
+
+/* Function to clean memory associated with the dispatcher */
+void elapi_destroy_dispatcher(struct elapi_dispatcher *dispatcher);
+
+/* Function to log an event */
+int elapi_dsp_log(struct elapi_dispatcher *dispatcher, struct collection_item *event);
+
+/* Function to log raw key value pairs without creating an event */
+int elapi_dsp_msg(struct elapi_dispatcher *dispatcher,
+                  struct collection_item *template,
+                  ...);
+
+/********** Advanced dispatcher management functions **********/
+
+/* Managing the sink collection */
+int elapi_alter_dispatcher(struct elapi_dispatcher *dispatcher,  /* Dispatcher */
+                           const char *sink,                     /* Sink to change */
+                           int action);                          /* Action to perform for sink */
+
+/* Get sink list */
+char **elapi_get_sink_list(struct elapi_dispatcher *dispatcher);
+
+/* Free sink list */
+void elapi_free_sink_list(char **sink_list);
+
+
+/******************** High level interface ************************************/
+/* This interface is not thread safe but convenient. It hides the dispatcher. */
+
+/* Function to initialize ELAPI library in the single threaded applications */
+/* If config_path = NULL the configuration will be read from the standard locations:
+ *  - First from the global configuration file "elapi.conf" located in the directory
+ *    defined at the compile time by the ELAPI_DEFAULT_CONFIG_DIR constant.
+ *    This file is assumed to contain common ELAPI configuration for this host;
+ *  - Second from the file with name constructed from appname by appending to it
+ *    suffix ".conf". The file will be looked in the directory pointed by
+ *    ELAPI_DEFAULT_CONFIG_APP_DIR constant that is defined at compile time.
+ *  The data from second file overwrites and complements the data from the first
+ *  one.
+ *  It is expected that applications will take advantage of the common
+ *  central convention so config_path should be NULL in most cases.
+ *
+ * If config_path points to a file the function will try to read the file
+ * as if it is a configuration file. The appname is ignored in this case.
+ * If config_path points to a directory, the function will try to read
+ * configuration from the file with name constructed by appending suffix ".conf"
+ * to appname. The file will be looked up in that directory.
+ * If the config_path is neither file or directory the default values will be used
+ * to initialize dispatcher.
+ *
+ * In case appname is NULL a default value defined by build time constant
+ * ELAPI_DEFAULT_APP_NAME will be used.
+ */
+int elapi_init(const char *appname, const char *config_path);
+
+/* Log key value pairs  */
+int elapi_msg(struct collection_item *template, ...);
+
+
+/* Log event  */
+int elapi_log(struct collection_item *event);
+
+/* Get dispatcher if you want to add sink to a default dispatcher or do some advanced operations */
+struct elapi_dispatcher *elapi_get_dispatcher(void);
+
+/* Close audit */
+void elapi_close(void);
+
+#endif