| 1 |
/*! |
| 2 |
|
| 3 |
\file eef.h |
| 4 |
\brief API of the Nextgen library |
| 5 |
\author Aram Verstegen |
| 6 |
|
| 7 |
This header contains the delcaration of the Nextgen library functions: |
| 8 |
-# EEF_Init(): Starts the Nextgen library, which invokes the Evaluation Manager, which in turn invokes the PluginManager to load and init the required plugins. |
| 9 |
-# EEF_Run(plugin_name): Runs the Nextgen library, which iterates through the list and invokes the PluginManager to run the selected plugins. |
| 10 |
-# EEF_Term(): Terminates the Nextgen library, prompting a cleanup of the stored data in the AOS and plugin manager. |
| 11 |
|
| 12 |
-# AOS_Init(): Initializes the AOS to store data. |
| 13 |
-# AOS_TERM(): Terminates the AOS, clearing the allocated data. |
| 14 |
-# eef_log(): Logging function for internal library use. |
| 15 |
|
| 16 |
*/ |
| 17 |
#ifndef EEF_H |
| 18 |
#define EEF_H |
| 19 |
#include <syslog.h> |
| 20 |
#include <stdarg.h> |
| 21 |
#include <stdio.h> |
| 22 |
#include "polytypes.h" |
| 23 |
|
| 24 |
#define MAX_TIME_STRING_SIZE 256 |
| 25 |
|
| 26 |
/*! Return codes to be used in the NG library. */ |
| 27 |
typedef enum { |
| 28 |
EES_SUCCESS, /*! Success */ |
| 29 |
EES_FAILURE /*! Failure */ |
| 30 |
} EES_RC; |
| 31 |
|
| 32 |
/*! Return codes to be used in NG plugins. */ |
| 33 |
typedef enum { |
| 34 |
EES_PL_SUCCESS, /*! Success */ |
| 35 |
EES_PL_FAILURE /*! Failure */ |
| 36 |
} EES_PL_RC; |
| 37 |
|
| 38 |
/* lifecycle functions */ |
| 39 |
|
| 40 |
extern EES_RC EEF_Init(char*); |
| 41 |
extern EES_RC EEF_Run(char* plugin); |
| 42 |
extern EES_RC EEF_Term(void); |
| 43 |
|
| 44 |
EES_RC AOS_Init (void); |
| 45 |
EES_RC AOS_Term (void); |
| 46 |
|
| 47 |
/* convenience methods */ |
| 48 |
const char* get_modules_path(void); |
| 49 |
extern EES_RC eef_log(int, const char*, ...); |
| 50 |
const char* append_newline(const char* string); |
| 51 |
#endif |
| 52 |
|
Parent Directory
| 
Revision Log