filter.h File Reference

#include <gwenhywfar/gwenhywfarapi.h>
#include <gwenhywfar/ringbuffer.h>
#include <gwenhywfar/inherit.h>

Go to the source code of this file.

Typedefs

typedef struct GWEN_FILTER GWEN_FILTER
typedef GWEN_FILTER_RESULT(* GWEN_FILTER_WORKFN )(GWEN_FILTER *f)

Enumerations

enum  GWEN_FILTER_RESULT { GWEN_Filter_ResultOk = 0, GWEN_Filter_ResultNeedMore, GWEN_Filter_ResultFull, GWEN_Filter_ResultError }

Functions

void GWEN_Filter_AppendNext (GWEN_FILTER *fPredecessor, GWEN_FILTER *fNew)
void GWEN_Filter_free (GWEN_FILTER *f)
GWEN_RINGBUFFERGWEN_Filter_GetInBuffer (const GWEN_FILTER *f)
GWEN_RINGBUFFERGWEN_Filter_GetOutBuffer (const GWEN_FILTER *f)
GWEN_FILTERGWEN_Filter_new (const char *name)
void GWEN_Filter_SetWorkFn (GWEN_FILTER *f, GWEN_FILTER_WORKFN fn)
GWEN_FILTER_RESULT GWEN_Filter_Work (GWEN_FILTER *f, int oneLoop)

Typedef Documentation

typedef struct GWEN_FILTER GWEN_FILTER

Definition at line 37 of file filter.h.

Definition at line 51 of file filter.h.


Enumeration Type Documentation

Enumerator:
GWEN_Filter_ResultOk 
GWEN_Filter_ResultNeedMore 
GWEN_Filter_ResultFull 
GWEN_Filter_ResultError 

Definition at line 43 of file filter.h.


Function Documentation

void GWEN_Filter_AppendNext ( GWEN_FILTER fPredecessor,
GWEN_FILTER fNew 
)

Appends a successor to the given filter. This means data output by fPredecessor is from now on additionally fed to the fNew. If nPredecessor already has a successor then the data stream will be duplicated to feed all successors.

Definition at line 114 of file filter.c.

void GWEN_Filter_free ( GWEN_FILTER f  ) 

Definition at line 71 of file filter.c.

References GWEN_FREE_OBJECT, GWEN_INHERIT_FINI, GWEN_LIST_FINI, and GWEN_RingBuffer_free().

GWEN_RINGBUFFER* GWEN_Filter_GetInBuffer ( const GWEN_FILTER f  ) 

Definition at line 85 of file filter.c.

GWEN_RINGBUFFER* GWEN_Filter_GetOutBuffer ( const GWEN_FILTER f  ) 

Definition at line 92 of file filter.c.

GWEN_FILTER* GWEN_Filter_new ( const char *  name  ) 

Definition at line 53 of file filter.c.

References GWEN_INHERIT_INIT, GWEN_LIST_INIT, GWEN_NEW_OBJECT, and GWEN_RingBuffer_new().

void GWEN_Filter_SetWorkFn ( GWEN_FILTER f,
GWEN_FILTER_WORKFN  fn 
)

Definition at line 99 of file filter.c.

GWEN_FILTER_RESULT GWEN_Filter_Work ( GWEN_FILTER f,
int  oneLoop 
)

Generated on Sat Jan 2 09:32:37 2010 for gwenhywfar by  doxygen 1.6.1