oob.h File Reference

Defines the "Out of Band" objects in a stream. More...

#include <das3/util.h>
#include <das3/buffer.h>

Include dependency graph for oob.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	OutOfBand
	A container for Out-of-Band data. More...
struct	OobExcept
	describes an exception that can live in a stream. More...
struct	OobComment
	describes human-consumable messages that exist on the stream. More...

Functions
DAS_API void	OutOfBand_clean (OutOfBand *pThis)
	Clean up extra memory allocated when an out of band object is initialized.
DAS_API void	OobExcept_set (OobExcept *pThis, das_except_t nType, const char *sMsg)
	Set an exception structure to a particular exception.

Detailed Description

Defines the "Out of Band" objects in a stream.

These are comments and exceptions

Function Documentation

OutOfBand_clean()

DAS_API void OutOfBand_clean

(

OutOfBand *

pThis

)

Clean up extra memory allocated when an out of band object is initialized.

Parameters

pThis

the out of band item to clean up.

OobExcept_set()

DAS_API void OobExcept_set	(	OobExcept *	pThis,
		das_except_t	nType,
		const char *	sMsg
	)

Set an exception structure to a particular exception.

Parameters

pThis	A pointer to the exception to initialize
nType	The type of exception, one of: DAS_EX_NO_DATA DAS_EX_SERVER_ERR DAS_EX_QUERY_ERR
sMsg	The message for the exception, this is a human readable string.