PipelineFilter Class Reference

A pipeline element the runs a filter plugin. More...

#include <pipeline_element.h>

Inheritance diagram for PipelineFilter:

Collaboration diagram for PipelineFilter:

Public Member Functions
	PipelineFilter (const std::string &name, const ConfigCategory &filterDetails)
	Construct the PipelineFilter class. More...
	~PipelineFilter ()
	Destructor for the pipeline filter element.
bool	setupConfiguration (ManagementClient *mgtClient, std::vector< std::string > &children)
	Setup the configuration for a filter in a pipeline. More...
void	ingest (READINGSET *readingSet)
bool	setup (ManagementClient *mgmt, void *ingest, std::map< std::string, PipelineElement * > &categories)
	Setup the configuration categories for the filter element in a pipeline. More...
bool	init (OUTPUT_HANDLE *outHandle, OUTPUT_STREAM output)
	Initialise the pipeline filter ready for ingest of data. More...
void	shutdown (ServiceHandler *serviceHandler, ConfigHandler *configHandler)
	Shutdown a pipeline element that is a filter. More...
void	reconfigure (const std::string &newConfig)
	Reconfigure method.
bool	isFilter ()
std::string	getCategoryName ()
bool	persistData ()
void	setPluginData (PluginData *data)
std::string	getPluginData ()
void	setServiceName (const std::string &name)
std::string	getName ()
bool	isReady ()
Public Member Functions inherited from PipelineElement
void	setNext (PipelineElement *next)
PipelineElement *	getNext ()
void	setService (const std::string &serviceName)
void	setStorage (StorageClient *storage)
bool	attachDebugger ()
	Attach a debugger class to the pipeline. More...
void	detachDebugger ()
	Detach a pipeline debugger from the pipeline element.
void	setDebuggerBuffer (unsigned int size)
	Setup the size of the debug buffer. More...
std::vector< std::shared_ptr< Reading > >	getDebuggerBuffer ()
	Fetch the content of the debugger buffer. More...
virtual bool	isBranch ()

Additional Inherited Members
Static Public Member Functions inherited from PipelineElement
static void	ingest (void *handle, READINGSET *readings)
Protected Attributes inherited from PipelineElement
std::string	m_serviceName
PipelineElement *	m_next
StorageClient *	m_storage
PipelineDebugger *	m_debugger

Detailed Description

A pipeline element the runs a filter plugin.

Constructor & Destructor Documentation

PipelineFilter()

PipelineFilter::PipelineFilter	(	const std::string &	name,
		const ConfigCategory &	filterDetails
	)

Construct the PipelineFilter class.

This is the specialisation of the PipelineElement that represents a running filter in the pipeline.

Member Function Documentation

init()

bool PipelineFilter::init ( OUTPUT_HANDLE *  outHandle, OUTPUT_STREAM  output  )

virtual

Initialise the pipeline filter ready for ingest of data.

Parameters

outHandle	The pipeline element we are sending the data to
output

Implements PipelineElement.

setup()

bool PipelineFilter::setup ( ManagementClient *  mgmt, void *  ingest, std::map< std::string, PipelineElement * > &  categories  )

virtual

Setup the configuration categories for the filter element in a pipeline.

Parameters

mgmt	The Management client
ingest	The service handler for our service
filterCatiegories	A map of the category name to pipeline element

Implements PipelineElement.

setupConfiguration()

bool PipelineFilter::setupConfiguration ( ManagementClient *  mgtClient, std::vector< std::string > &  children  )

virtual

Setup the configuration for a filter in a pipeline.

Parameters

mgtClient	The managament client
children	A vector to fill with child configuration categories

Reimplemented from PipelineElement.

shutdown()

void PipelineFilter::shutdown ( ServiceHandler *  serviceHandler, ConfigHandler *  configHandler  )

virtual

Shutdown a pipeline element that is a filter.

Remove registration for categories of interest, persist and plugin data that needs persisting and call shutdown on the plugin itself.

Parameters

serviceHandler	The service handler of the service that is hostign the pipeline
configHandler	The config handler for the service from which we unregister

Implements PipelineElement.

---

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

• C/common/include/pipeline_element.h
• C/common/pipeline_filter.cpp