FilterPipeline Class Reference

The FilterPipeline class is used to represent a pipeline of filters applicable to a task/service. More...

#include <filter_pipeline.h>

Inheritance diagram for FilterPipeline:

Collaboration diagram for FilterPipeline:

Public Member Functions
	FilterPipeline (ManagementClient *mgtClient, StorageClient &storage, std::string serviceName)
	FilterPipeline class constructor. More...
	~FilterPipeline ()
	FilterPipeline destructor.
PipelineElement *	getFirstFilterPlugin ()
unsigned int	getFilterCount ()
void	configChange (const std::string &, const std::string &)
	Configuration change for one of the filters. More...
void	cleanupFilters (const std::string &categoryName)
	Cleanup all the loaded filters. More...
bool	loadFilters (const std::string &categoryName)
	Load all filter plugins in the pipeline. More...
bool	setupFiltersPipeline (void *passToOnwardFilter, void *useFilteredData, void *ingest)
	Set the filter pipeline. More...
bool	isReady ()
bool	hasChanged (const std::string pipeline) const
bool	isShuttingDown ()
void	setShuttingDown ()
void	execute ()
	Called when we pass the data into the pipeline. More...
void	awaitCompletion ()
	Wait for all active branches of the pipeline to complete.
void	startBranch ()
	A new branch has started in the pipeline.
void	completeBranch ()
	A branch in the pipeline has completed.
bool	attachDebugger ()
	Attach the debugger to the pipeline elements. More...
void	detachDebugger ()
	Detach the debugger from the pipeline elements.
void	setDebuggerBuffer (unsigned int size)
	Set the debugger buffer size to the pipeline elements. More...
std::string	getDebuggerBuffer ()
	Get the debugger buffer contents for all the pipeline elements. More...
std::string	getDebuggerBuffer (const std::string &name)
bool	replayDebugger ()
	Replay the data in the first saved buffer to the filter pipeline. More...

Protected Attributes
ManagementClient *	mgtClient
StorageClient &	storage
std::string	serviceName
std::vector< PipelineElement * >	m_filters
std::map< std::string, PipelineElement * >	m_filterCategories
std::string	m_pipeline
bool	m_ready
bool	m_shutdown
ServiceHandler *	m_serviceHandler
int	m_activeBranches
std::mutex	m_actives
std::condition_variable	m_branchActivations

Detailed Description

The FilterPipeline class is used to represent a pipeline of filters applicable to a task/service.

Methods are provided to load filters, setup filtering pipeline and for pipeline/filters cleanup.

Constructor & Destructor Documentation

FilterPipeline()

FilterPipeline::FilterPipeline	(	ManagementClient *	mgtClient,
		StorageClient &	storage,
		std::string	serviceName
	)

FilterPipeline class constructor.

This class abstracts the filter pipeline interface

Parameters

mgtClient	Management client handle
storage	Storage client handle
serviceName	Name of the service to which this pipeline applies

Member Function Documentation

attachDebugger()

bool FilterPipeline::attachDebugger

(

)

Attach the debugger to the pipeline elements.

Returns

bool True if the pipeline was attached

cleanupFilters()

void FilterPipeline::cleanupFilters

(

const std::string &

categoryName

)

Cleanup all the loaded filters.

Call "plugin_shutdown" method and free the FilterPlugin object

Parameters

categoryName

Configuration category name

configChange()

void FilterPipeline::configChange	(	const std::string &	,
		const std::string &
	)

Configuration change for one of the filters.

Lookup the category name and find the plugin to call. Call the reconfigure method of that plugin with the new configuration.

Parameters

category	The name of the configuration category
newConfig	The new category contents

execute()

void FilterPipeline::execute

(

)

Called when we pass the data into the pipeline.

Set the number of active branches to 1

getDebuggerBuffer()

string FilterPipeline::getDebuggerBuffer

(

)

Get the debugger buffer contents for all the pipeline elements.

Returns

string JSON document with all the buffer contents

loadFilters()

bool FilterPipeline::loadFilters

(

const std::string &

categoryName

)

Load all filter plugins in the pipeline.

Parameters

categoryName

Configuration category name

Returns

True if filters are loaded (or no filters at all) False otherwise

replayDebugger()

bool FilterPipeline::replayDebugger

(

)

Replay the data in the first saved buffer to the filter pipeline.

Returns

bool Returns true if data has been replayed, otehrwise retuns false

setDebuggerBuffer()

void FilterPipeline::setDebuggerBuffer

(

unsigned int

size

)

Set the debugger buffer size to the pipeline elements.

Parameters

size	The request number of readings to buffer

setupFiltersPipeline()

bool FilterPipeline::setupFiltersPipeline	(	void *	passToOnwardFilter,
		void *	useFilteredData,
		void *	ingest
	)

Set the filter pipeline.

This method calls the method "plugin_init" for all loadad filters. Up-to-date filter configurations and Ingest filtering methods are passed to "plugin_init"

Parameters

passToOnwardFilter	Ptr to function that passes data to next filter
useFilteredData	Ptr to function that gets final filtered data
ingest	The ingest class handle

Returns

True on success, False otherwise. @thown Any caught exception

---

The documentation for this class was generated from the following files:

• C/common/include/filter_pipeline.h
• C/common/filter_pipeline.cpp