pipeline_interface_t Struct Reference

Interface returned to other modules which require integration with the pipeline. More...

Data Fields
int	patch
int(*	pipeline_database_delete )(const char *symbol)
	Delete all data for a symbol. More...
int(*	pipeline_database_insert )(const char *symbol, const char *key, pipeline_datatype_t type, void *dataptr)
	Insert new data into the database. More...
int(*	pipeline_database_retrieve )(const char *symbol, const char *key, pipeline_datatype_t *type, void **dataptr)
	Retrieve some data from the database. More...
pipeline_t *(*	pipeline_generate )(char *file, pipeline_eventnames_t *eventnames)
	Generate the pipeline. More...
pipeline_t *(*	pipeline_generate_with_log )(char *file, ds_log_t *logfile, pipeline_eventnames_t *eventnames)
	Generate the pipeline. More...
void *(*	pipeline_get_closure )(void *state)
	Gets the closure associated with the current function. More...
int(*	pipeline_get_num_args )(void *state)
	Get number of arguments passed to a pipeline function. More...
int(*	pipeline_getarg )(void *state, int argnum, pipeline_datatype_t type, void *dest)
	Get an argument for a function. More...
int(*	pipeline_getarg_from_map )(void *state, int argnum, const char *key, pipeline_datatype_t type, void *dest)
	Get a value for a key within a map parameter for a function. More...
int(*	pipeline_getarg_map_keys )(void *state, int argnum, char ***dest)
	Get a list of keys within the map at the specified argument. More...
int(*	pipeline_initialise )(pipeline_t *pipe)
	Initialise the pipeline. More...
int(*	pipeline_register_function )(char *name, pipeline_cb callback)
	Make a function available to a pipeline. More...
int(*	pipeline_register_function_closure )(char *name, pipeline_cb callback, void *closure)
	Make a function available to a pipeline (with a closure) More...
int(*	pipeline_register_library )(const char *libname, const pipeline_module_func_t *funcs, const pipeline_module_const_t *constants)
	Make a library of functions and constants available to a pipeline. More...
int(*	pipeline_release )(pipeline_t *pipeline)
	Release a pipeline. More...
pipeline_return_type_t(*	pipeline_return )(void *state)
	Function to return the appropriate value to the script. More...
int(*	pipeline_setret )(void *state, pipeline_datatype_t type, void *retval)
	Set a return value for a function. More...
int(*	pipeline_setret_array )(void *state, int num, char **array)
	Set an array as the return value for a pipeline function. More...
int(*	pipeline_setret_map )(void *state, int num, char **map_values)
	Set a map as the return value for a pipeline function. More...
int	version

Detailed Description

Interface returned to other modules which require integration with the pipeline.

To obtain this interface, the following should be performed:

pipeline_interface_t   *interface;
pipeline_interface_t   *(*get_pipeline)();

if ( ( get_pipeline = tf_find_function("pipeline_get_interface") ) != NULL ) {
    pipeline_interface = get_pipeline();
    // At this point, pipeline_interface points to the interface definition of the pipeline module
}

Field Documentation

int pipeline_interface_t::patch

Patch version of the pipeline module

int pipeline_interface_t::version

Version number of the pipeline module

---

The documentation for this struct was generated from the following file:

• pipeline.h