FiltersChain Class Reference

List of all members.

Public Member Functions
int	addFilter (Filter *, u_long *nbw, int sendData=1)
int	clear ()
void	clearAllFilters ()
	FiltersChain ()
int	flush (u_long *)
int	getAcceptDuplicates ()
Filter *	getFirstFilter ()
void	getName (string &out)
Protocol *	getProtocol ()
void *	getProtocolData ()
Stream *	getStream ()
int	hasModifiersFilters ()
int	isEmpty ()
int	isFilterPresent (const char *)
int	isFilterPresent (Filter *)
int	read (char *buffer, u_long len, u_long *)
int	removeFilter (Filter *)
void	setAcceptDuplicates (int)
void	setProtocol (Protocol *pr)
void	setProtocolData (void *prd)
void	setStream (Stream *)
int	write (const char *buffer, u_long len, u_long *)
	~FiltersChain ()
Protected Attributes
int	acceptDuplicates
list< Filter * >	filters
Filter *	firstFilter
Protocol *	protocol
void *	protocolData
Stream *	stream

---

Constructor & Destructor Documentation

FiltersChain::FiltersChain (   )

Initialize the chain object.

FiltersChain::~FiltersChain (   )

Destroy the chain.

---

Member Function Documentation

int FiltersChain::addFilter (  Filter *  f, u_long *  nbw, int  sendData = 1 )

Add a filter to the chain. Returns 0 on success. the number of bytes written to initialize the filter.

int FiltersChain::clear (   )

void FiltersChain::clearAllFilters (   )

Destroy filters objects. This destroys all the filters objects in the list.

int FiltersChain::flush (  u_long *  nbw  )

Flush remaining data. Additional footer data for filters is added at the end. Returns 0 on success.

int FiltersChain::getAcceptDuplicates (   )

Return if the chain can have the same filter in multiple places.

Filter * FiltersChain::getFirstFilter (   )

Get the first filter of the chain.

void FiltersChain::getName (  string &  out  )

Fullfill the out string with a comma separated list of the filters present in the chain.

Protocol* FiltersChain::getProtocol (   )

void* FiltersChain::getProtocolData (   )

Stream * FiltersChain::getStream (   )

Get the stream usedby the chain.

int FiltersChain::hasModifiersFilters (   )

Returns a nonzero value if the chain contains any modifier filter.

int FiltersChain::isEmpty (   )

Returns a nonzero value if the chain is empty.

int FiltersChain::isFilterPresent (  const char *  name  )

Check if a filter is present in the chain by its name.

int FiltersChain::isFilterPresent (  Filter *  f  )

Check if a filter is present in the chain.

int FiltersChain::read (  char *  buffer, u_long  len, u_long *  nbr )

Read data from the chain. Returns 0 on success.

int FiltersChain::removeFilter (  Filter *  f  )

Remove the first occurrence of the specified filter from the chain.

void FiltersChain::setAcceptDuplicates (  int  v  )

Set if the chain can cointain duplicates of the same filter on different levels.

void FiltersChain::setProtocol (  Protocol *  pr  )

void FiltersChain::setProtocolData (  void *  prd  )

void FiltersChain::setStream (  Stream *  s  )

Set the stream where apply the filters.

int FiltersChain::write (  const char *  buffer, u_long  len, u_long *  nbw )

Write data using the chain. Returns 0 on success.

---

Member Data Documentation

int FiltersChain::acceptDuplicates [protected]

list<Filter*> FiltersChain::filters [protected]

Filter* FiltersChain::firstFilter [protected]

Protocol* FiltersChain::protocol [protected]

void* FiltersChain::protocolData [protected]

Stream* FiltersChain::stream [protected]

---