FilterManagerInterface man page

FilterManagerInterface —

Synopsis

#include <FilterManagerInterface.hh>

Inherited by SimpleFilterManager.

Public Member Functions

virtual void toolConnect (const char *toolName, ToolList::ReadIterator *iter)=0

virtual void toolDisconnect (const char *toolName, ToolList::ReadIterator *iter)=0

virtual void addFilter (const char *toolName, const char *filterName, ToolList::ReadIterator *iter)=0

virtual void removeFilter (const char *toolName, const char *filterName, ToolList::ReadIterator *iter)=0

virtual void flushAllFilters (const char *toolName, ToolList::ReadIterator *iter)=0

virtual tag_list_t * componentConnect (const char *componentName, ComponentList::ReadIterator *iter)=0

virtual void componentDisconnect (const char *componentName, ComponentList::ReadIterator *iter)=0

virtual void sendMessageWithFilters (log_msg_t *message)=0

Detailed Description

Interface to the Filtermanager (Abstract class) The FilterManager keeps track of all attached Components and of all configured filters. Based on this information, it can be used to filter incoming Messages and forward them to the appropriate tools. If tools change their filters, the FilterManager adjusts the Components output.

Member Function Documentation

virtual void FilterManagerInterface::addFilter (const char * toolName, const char * filterName, ToolList::ReadIterator * iter) [pure virtual]

Notify the manager that a new filter has been added. the filter must already exist in the toollist. A iterator used for inserting should be passed.

Implemented in SimpleFilterManager.

virtual tag_list_t* FilterManagerInterface::componentConnect (const char * componentName, ComponentList::ReadIterator * iter) [pure virtual]

Notify the manager that a component connected. The component should be already in the list, the corresponding iterator should be passed.

Implemented in SimpleFilterManager.

virtual void FilterManagerInterface::componentDisconnect (const char * componentName, ComponentList::ReadIterator * iter) [pure virtual]

Notify the manager that a component will disconnects. This must happen right before the deletion of the component. The iterator passed should be the same iterator used for deleting.

Implemented in SimpleFilterManager.

virtual void FilterManagerInterface::flushAllFilters (const char * toolName, ToolList::ReadIterator * iter) [pure virtual]

Notify the manager that all filters for a certain tool will be removed. The filtermanager might implement this more efficient that removing each filter one by one.

Implemented in SimpleFilterManager.

virtual void FilterManagerInterface::removeFilter (const char * toolName, const char * filterName, ToolList::ReadIterator * iter) [pure virtual]

Notify the manager that a filter will be removed. This function should be called right before deleting the filter. The iterator for deleting the filter should be passed.

Implemented in SimpleFilterManager.

virtual void FilterManagerInterface::sendMessageWithFilters (log_msg_t * message) [pure virtual]

Forwards a message to all interested Tools. The message will be checked and stored in the outBuffer of all tools with a matching filter.

Implemented in SimpleFilterManager.

virtual void FilterManagerInterface::toolConnect (const char * toolName, ToolList::ReadIterator * iter) [pure virtual]

Notify the manager that a new tool has connected. The Tool must already exist in the toolList. iter must be an ReadIterator to the toolList. It should be the same iterator that was used for inserting the tool.

Implemented in SimpleFilterManager.

virtual void FilterManagerInterface::toolDisconnect (const char * toolName, ToolList::ReadIterator * iter) [pure virtual]

Notify the manager that a tool is about disconnects. This function must be called right before deleting the tool from the list, as Filtermanager will delete all its internal data on this tool (including remaining filters). The iterator passed should be the iterator used for deleting the tool.

Implemented in SimpleFilterManager.

Author

Generated automatically by Doxygen for LogService from the source code.

Info

Wed Feb 3 2016 LogService