ees/include/eef.h

/*!

        \file eef.h
        \brief API of the Nextgen library
        \author Aram Verstegen

        This header contains the delcaration of the Nextgen library functions:
        -# EEF_Init(): Starts the Nextgen library, which invokes the Evaluation Manager, which in turn invokes the PluginManager to load and init the required plugins.
        -# EEF_Run(plugin_name): Runs the Nextgen library, which iterates through the list and invokes the PluginManager to run the selected plugins.
        -# EEF_Term(): Terminates the Nextgen library, prompting a cleanup of the stored data in the AOS and plugin manager.

  -# AOS_Init(): Initializes the AOS to store data.
  -# AOS_TERM(): Terminates the AOS, clearing the allocated data.
  -# eef_log(): Logging function for internal library use.

*/
#ifndef EEF_H
#define EEF_H
#include <syslog.h>
#include <stdarg.h>
#include <stdio.h>
#include "polytypes.h"

#define MAX_TIME_STRING_SIZE 256

/*! Return codes to be used in the NG library. */
typedef enum {
  EES_SUCCESS, /*! Success */
  EES_FAILURE  /*! Failure */
} EES_RC;

/*! Return codes to be used in NG plugins. */
typedef enum {
  EES_PL_SUCCESS, /*! Success */
  EES_PL_FAILURE  /*! Failure */
} EES_PL_RC;

/* lifecycle functions */

extern EES_RC         EEF_Init(char*);
extern EES_RC         EEF_Run(char* plugin);
extern EES_RC         EEF_Term(void);

EES_RC                                        AOS_Init (void);
EES_RC                                        AOS_Term (void);

/* convenience methods */
const char*           get_modules_path(void);
extern EES_RC         eef_log(int, const char*, ...);
const char*           append_newline(const char* string);
#endif

1	aramv	460	/*!
2
3	aramv	781	\file eef.h
4	aramv	460	\brief API of the Nextgen library
5			\author Aram Verstegen
6
7			This header contains the delcaration of the Nextgen library functions:
8	aramv	810	-# 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	aramv	460
12	aramv	525	-# AOS_Init(): Initializes the AOS to store data.
13			-# AOS_TERM(): Terminates the AOS, clearing the allocated data.
14	aramv	810	-# eef_log(): Logging function for internal library use.
15	aramv	525
16	aramv	460	*/
17	aramv	810	#ifndef EEF_H
18			#define EEF_H
19	aramv	484	#include <syslog.h>
20			#include <stdarg.h>
21	aramv	592	#include <stdio.h>
22			#include "polytypes.h"
23	aramv	484
24	aramv	502	#define MAX_TIME_STRING_SIZE 256
25	aramv	484
26	aramv	525	/! Return codes to be used in the NG library. /
27	aramv	502	typedef enum {
28	aramv	781	EES_SUCCESS, /! Success /
29			EES_FAILURE /! Failure /
30			} EES_RC;
31	aramv	484
32	aramv	525	/! Return codes to be used in NG plugins. /
33	aramv	502	typedef enum {
34	aramv	781	EES_PL_SUCCESS, /! Success /
35			EES_PL_FAILURE /! Failure /
36			} EES_PL_RC;
37	aramv	484
38	aramv	844	/* lifecycle functions */
39	aramv	484
40	aramv	844	extern EES_RC EEF_Init(char*);
41			extern EES_RC EEF_Run(char* plugin);
42			extern EES_RC EEF_Term(void);
43	aramv	502
44	aramv	844	EES_RC AOS_Init (void);
45			EES_RC AOS_Term (void);
46	aramv	502
47	aramv	844	/* convenience methods */
48			const char* get_modules_path(void);
49			extern EES_RC eef_log(int, const char*, ...);
50	aramv	858	const char* append_newline(const char* string);
51	aramv	425	#endif
52	aramv	484
grid.support@nikhef.nl	ViewVC Help
Powered by ViewVC 1.1.28