_RECEIVERINFO Struct Reference

#include <receiver.h>

Collaboration diagram for _RECEIVERINFO:

[legend]

---

Detailed Description

Receiver information structure.

An instance of this structure is created when calling ReceiverCreate().

Definition at line 88 of file receiver.h.

Data Fields
u_int	ri_status
	Current status of the receiver.
HANDLE	ri_cmdevt
	Receiver plug-in command event queue.
HANDLE	ri_stsevt
	Receiver plug-in status event queue.
u_char *	ri_buff
	Receiver buffer.
u_int	ri_wpos
	Ring buffer write position.
u_int	ri_rpos
	Ring buffer write position.
u_int	ri_avail
	Number of bytes available in the ring buffer.
HANDLE	ri_wrbque
	Ring buffer write event queue.
HANDLE	ri_rdbque
	Ring buffer read event queue.
STATIONINFO *	ri_sip
	Pointer to the station information structure.
RECEIVERPLUGIN *	ri_rpp
	Pointer to the plug-in reference structure.
void *	ri_bcast
	Receiver plug-in local data.

---

Field Documentation

u_int _RECEIVERINFO::ri_status

Current status of the receiver. RSTAT_IDLE if stopped. RSTAT_START if currently starting. RSTAT_RUNNING if started. RSTAT_STOP if currently stopping. Definition at line 96 of file receiver.h.

HANDLE _RECEIVERINFO::ri_cmdevt

Receiver plug-in command event queue. An event is posted to this queue whenever a status change is requested. Definition at line 101 of file receiver.h.

HANDLE _RECEIVERINFO::ri_stsevt

Receiver plug-in status event queue. An event is posted by the receiver plug-in to this queue whenever a status change took place. Definition at line 107 of file receiver.h.

u_char* _RECEIVERINFO::ri_buff

Receiver buffer. The receiver plug-in will store incoming data in this ring buffer. Definition at line 112 of file receiver.h.

u_int _RECEIVERINFO::ri_wpos

Ring buffer write position. Definition at line 115 of file receiver.h.

u_int _RECEIVERINFO::ri_rpos

Ring buffer write position. Definition at line 118 of file receiver.h.

u_int _RECEIVERINFO::ri_avail

Number of bytes available in the ring buffer. Definition at line 121 of file receiver.h.

HANDLE _RECEIVERINFO::ri_wrbque

Ring buffer write event queue. An event is posted to this queue whenever data had been added to the ring buffer. Definition at line 127 of file receiver.h.

HANDLE _RECEIVERINFO::ri_rdbque

Ring buffer read event queue. An event is posted to this queue whenever data had been removed from the ring buffer. Definition at line 133 of file receiver.h.

STATIONINFO* _RECEIVERINFO::ri_sip

Pointer to the station information structure. Definition at line 136 of file receiver.h.

RECEIVERPLUGIN* _RECEIVERINFO::ri_rpp

Pointer to the plug-in reference structure. Definition at line 139 of file receiver.h.

void* _RECEIVERINFO::ri_bcast

Receiver plug-in local data. Can be used by the receiver plug-in to store local data. Definition at line 144 of file receiver.h.

---

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

• receiver.h

---