et_fifo_context_t Struct Reference

Structure to hold the context of a fifo connection to ET. More...

#include <et_fifo.h>

Data Fields
size_t	evSize
	Size in bytes of each ET buffer/event. More...
int	evCount
	Number of buffers/events in ET system. More...
int	entries
	Total number of fifo entries in ET system. More...
int	userEntries
	For consumers, max number of fifo entries in Users station (<= entries). More...
int	producer
	True if producing fifo entries, false if consuming fifo entries. More...
int	capacity
	Total number of buffer contained in this fifo element. More...
et_sys_id	openId
	Id returned from et_open. More...
et_stat_id	userStatId
	User station id for both producers & consumers. More...
et_att_id	attId
	Attachment to GrandCentral Station for data producers User for data consumers. More...
int	idCount
	Number of elements in bufIds array (if is producer). More...
int *	bufIds
	Array to hold ids - one for each buffer of a fifo entry (if is producer). More...

Detailed Description

Structure to hold the context of a fifo connection to ET.

Field Documentation

attId

et_att_id et_fifo_context_t::attId

Attachment to GrandCentral Station for data producers User for data consumers.

Referenced by et_fifo_close(), et_fifo_getEntry(), et_fifo_getEntryTO(), et_fifo_newEntry(), et_fifo_newEntryTO(), and et_fifo_putEntry().

bufIds

int* et_fifo_context_t::bufIds

Array to hold ids - one for each buffer of a fifo entry (if is producer).

Referenced by et_fifo_close(), et_fifo_getBufIds(), et_fifo_newEntry(), and et_fifo_newEntryTO().

capacity

int et_fifo_context_t::capacity

Total number of buffer contained in this fifo element.

Referenced by et_fifo_entryCreate(), et_fifo_getBuf(), et_fifo_getEntry(), et_fifo_getEntryCapacity(), et_fifo_getEntryTO(), et_fifo_newEntry(), et_fifo_newEntryTO(), and et_fifo_putEntry().

entries

int et_fifo_context_t::entries

Total number of fifo entries in ET system.

evCount

int et_fifo_context_t::evCount

Number of buffers/events in ET system.

evSize

size_t et_fifo_context_t::evSize

Size in bytes of each ET buffer/event.

Referenced by et_fifo_getBufSize(), et_fifo_newEntry(), and et_fifo_newEntryTO().

idCount

int et_fifo_context_t::idCount

Number of elements in bufIds array (if is producer).

Referenced by et_fifo_allHaveData(), et_fifo_getBufIds(), et_fifo_getIdCount(), et_fifo_newEntry(), and et_fifo_newEntryTO().

openId

et_sys_id et_fifo_context_t::openId

Id returned from et_open.

Referenced by et_fifo_close(), et_fifo_getEntry(), et_fifo_getEntryTO(), et_fifo_getFillLevel(), et_fifo_newEntry(), et_fifo_newEntryTO(), and et_fifo_putEntry().

producer

int et_fifo_context_t::producer

True if producing fifo entries, false if consuming fifo entries.

Referenced by et_fifo_getEntry(), et_fifo_getEntryTO(), et_fifo_newEntry(), and et_fifo_newEntryTO().

userEntries

int et_fifo_context_t::userEntries

For consumers, max number of fifo entries in Users station (<= entries).

Referenced by et_fifo_getEntryCount().

userStatId

et_stat_id et_fifo_context_t::userStatId

User station id for both producers & consumers.

Referenced by et_fifo_getFillLevel().

---

The documentation for this struct was generated from the following file:

• et_fifo.h