pipeline.h File Reference

Defines pipelines, structures to hold many closures and functions to invoke them sequentially, composing their functionality. More...

#include "uevloop/utils/closure.h"

Include dependency graph for pipeline.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	uel_pipeline_t
	A pipeline is an ordered closure list to be run in sequence. More...

Macros
#define	UEL_PIPELINE_DECLARE(id, ...)
	Helper macro to create a pipeline and its required data structures. More...

Functions
void	uel_pipeline_init (uel_pipeline_t *pipeline, uel_closure_t *closures, size_t count)
	Initialises a new pipeline. More...
void *	uel_pipeline_apply (uel_pipeline_t *pipeline, void *params)
	Applies a pipeline to some input. More...

Detailed Description

Defines pipelines, structures to hold many closures and functions to invoke them sequentially, composing their functionality.

Macro Definition Documentation

UEL_PIPELINE_DECLARE

#define UEL_PIPELINE_DECLARE	(		id,
			...
	)

Value:

    uel_closure_t id##_pipeline_closures[] = {__VA_ARGS__};                   \
    uel_pipeline_t id##_pipeline;                                             \
    uel_pipeline_init(&id##_pipeline, id##_pipeline_closures,                 \
                    sizeof(id##_pipeline_closures) / sizeof(uel_closure_t));

Helper macro to create a pipeline and its required data structures.

This macro, based on the input identifier, declares:

• a closure array with any supplied closures ([id]_pipeline_closures)
• a pipeline object wrapping the closure array ([id]_pipeline)

Parameters

id	The identifier on which to base declared variables' names.
...	The closures to be pipelined.

Function Documentation

uel_pipeline_apply()

void* uel_pipeline_apply	(	uel_pipeline_t *	pipeline,
		void *	params
	)

Applies a pipeline to some input.

This function takes some input and passes it to the first closure in the pipeline. The value returned from this first closure will be passed to the second one and so on.

Parameters

pipeline	The pipeline to be applied
params	The initial parameters that will be passed to the first closure

Returns

Whatever was returned by the last closure invoked

uel_pipeline_init()

void uel_pipeline_init	(	uel_pipeline_t *	pipeline,
		uel_closure_t *	closures,
		size_t	count
	)

Initialises a new pipeline.

Parameters

pipeline	The pipeline to be initialised
closures	The closures that should be run in sequence, in an array.
count	The number of closures to be piped.