oSIP fifo Handling
[The OS port modules]


Classes

struct  osip_fifo
struct  osip_fifo

Typedefs

typedef struct osip_fifo osip_fifo_t

Functions

void osip_fifo_init (osip_fifo_t *ff)
void osip_fifo_free (osip_fifo_t *ff)
int osip_fifo_insert (osip_fifo_t *ff, void *element)
int osip_fifo_add (osip_fifo_t *ff, void *element)
int osip_fifo_size (osip_fifo_t *ff)
void * osip_fifo_get (osip_fifo_t *ff)
void * osip_fifo_tryget (osip_fifo_t *ff)

Typedef Documentation

osip_fifo_t

Structure for referencing a fifo.


Function Documentation

int osip_fifo_add ( osip_fifo_t ff,
void *  element 
)

Add an element in a fifo.

Parameters:
ff The element to work on.
element The pointer on the element to add.

void osip_fifo_free ( osip_fifo_t ff  ) 

Free a fifo element.

Parameters:
ff The element to work on.

void* osip_fifo_get ( osip_fifo_t ff  ) 

Get an element from a fifo or block until one is added.

Parameters:
ff The element to work on.

void osip_fifo_init ( osip_fifo_t ff  ) 

Initialise a osip_fifo_t element. NOTE: this element MUST be previously allocated with osip_malloc(). The osip_free() call on the fifo is still automatically done by osip_fifo_free(). This also means you can't use a static osip_fifo_t variable if you want to use osip_fifo_free().

Parameters:
ff The element to initialise.

int osip_fifo_insert ( osip_fifo_t ff,
void *  element 
)

Insert an element in a fifo (at the beginning).

Parameters:
ff The element to work on.
element The pointer on the element to insert.

int osip_fifo_size ( osip_fifo_t ff  ) 

Get the number of element in a fifo.

Parameters:
ff The element to work on.

void* osip_fifo_tryget ( osip_fifo_t ff  ) 

Try to get an element from a fifo, but do not block if there is no element.

Parameters:
ff The element to work on.


Generated on Wed Feb 13 01:03:29 2008 for libosip by  doxygen 1.5.4