GRB_stream.h File Reference

GRB stream Utilities, Interface. More...

Typedefs
typedef enum _GRB_STREAM_TYPE_K	GRB_STREAM_TYPE_K
	Standard typedef for _enum GRB_STREAM_TYPE_K.
typedef enum _GRB_STREAM_TYPE_K	GRB_streamType
	Typedef for _enum GRB_STREAM_TYPE_K, used in procedure calls.
typedef enum _GRB_STREAM_UNIT_K	GRB_STREAM_UNIT_K
	Typedef for enum _GRB_STREAM_UNIT_K.
typedef enum _GRB_STREAM_UNIT_K	GRB_streamUnit
	Typedef for enum _GRB_streamUnit.
Enumerations
enum	_GRB_STREAM_TYPE_K {   GRB_STREAM_TYPE_K_FILE = 0,   GRB_STREAM_TYPE_K_DATA = 1,   GRB_STREAM_TYPE_K_FILESEG = 2 }
enum	_GRB_STREAM_UNIT_K {   GRB_STREAM_UNIT_K_PKTS = 0,   GRB_STREAM_UNIT_K_EVTS = 1 }
	Enumeration of how to treat the input stream, as packets or events. More...
enum	_GRB_STREAM_PKT_SIZE_K_MAX {   GRB_STREAM_PKT_SIZE_K_MAX = -1,   GRB_STREAM_PKT_SIZE_K_DEF = 0 }
	Enumerates the sentinal values used when specifying a packet size. More...
Functions
GRB_stream *	GRB_streamOpen (GRB_streamType type, const void *name, int segment)
int	GRB_streamRead (GRB_stream *stream)
const GRB_pktHdr *	GRB_streamLocate (GRB_stream *stream, int advance)
GRB_stream *	GRB_streamCreate (GRB_streamType type, const char *name, int rsvd_mbz)
int	GRB_streamPktWrite (GRB_stream *stream, const GRB_pktHdr *pkt)
int	GRB_streamClose (GRB_stream *stream)
int	GRB_streamFree (GRB_stream *stream)
Variables
enum _GRB_STREAM_PKT_SIZE_K_MAX	GRB_STREAM_PKT_SIZE_K

---

Detailed Description

GRB stream Utilities, Interface.

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id: GRB_stream.h,v 1.1.1.1 2007/06/18 00:42:58 russell Exp $

Routines for reading/writing files/data sections in Event Builder format.

---

Enumeration Type Documentation

enum _GRB_STREAM_PKT_SIZE_K_MAX

Enumerates the sentinal values used when specifying a packet size.

Enumerator:

GRB_STREAM_PKT_SIZE_K_MAX	Typedef of struct _GRB_STREAM_PKT_SIZE_K. Use the maximum packet size
GRB_STREAM_PKT_SIZE_K_DEF	Use the default packet size set in the stream handle

enum _GRB_STREAM_TYPE_K

Enumerator:

GRB_STREAM_TYPE_K_FILE	Stream type is a file
GRB_STREAM_TYPE_K_DATA	Stream type is a data section
GRB_STREAM_TYPE_K_FILESEG	Stream type is a segmented file

enum _GRB_STREAM_UNIT_K

Enumeration of how to treat the input stream, as packets or events.

Enumerator:

GRB_STREAM_UNIT_K_PKTS	Treat the stream as a stream of packets
GRB_STREAM_UNIT_K_EVTS	Treat the stream as a stream of events