das2/processor.h File Reference

Callback processing for das2 stream reads and writes. More...

---

Detailed Description

Callback processing for das2 stream reads and writes.

These structure allow one to hook in Das2 Stream object processing that is triggered when Headers and Data are read or written to a file.

#include <das2/stream.h>
#include <das2/oob.h>

Go to the source code of this file.

Data Structures
interface	StreamHandler
	A set of callbacks used for input and output stream processing. More...
Typedefs
typedef ErrorCode(*	StreamDescHandler )(StreamDesc *sd, void *ud)
	Definition of the callback function invoked when a stream header is encountered in the input.
typedef ErrorCode(*	PktDescHandler )(StreamDesc *sd, PktDesc *pd, void *ud)
	Definition of the callback function invoked when a packet header is encountered in the input.
typedef ErrorCode(*	PktDataHandler )(PktDesc *pd, void *ud)
	Callback function invoked when a data packet is encountered in the input.
typedef ErrorCode(*	CloseHandler )(StreamDesc *sd, void *ud)
	Callback functions that invoked on Stream Close callback function that is called at the end of the stream.
typedef ErrorCode(*	ExceptionHandler )(OobExcept *se, void *ud)
	Callback functions that handle exceptions.
typedef ErrorCode(*	CommentHandler )(OobComment *se, void *ud)
	Callback functions that handle comments.

---

Typedef Documentation

typedef ErrorCode(* StreamDescHandler)(StreamDesc *sd, void *ud)

Definition of the callback function invoked when a stream header is encountered in the input.

Parameters:

	sd	A pointer to the parsed StreamDesc
	pd	A pointer to a user data structure, may be NULL.

See also:

StreamHandler

typedef ErrorCode(* PktDescHandler)(StreamDesc *sd, PktDesc *pd, void *ud)

Definition of the callback function invoked when a packet header is encountered in the input.

Parameters:

	sd	A pointer to the parsed Stream Descriptor
	pd	A pointer to the parsed Packet Descriptor
	ud	A pointer to a user data structure, may be NULL.

See also:

StreamHandler

typedef ErrorCode(* PktDataHandler)(PktDesc *pd, void *ud)

Callback function invoked when a data packet is encountered in the input.

Parameters:

	sd	A pointer to the parsed Packet Descriptor
	ud	A pointer to a user data structure, may be NULL.

See also:

StreamHandler

typedef ErrorCode(* CloseHandler)(StreamDesc *sd, void *ud)

Callback functions that invoked on Stream Close callback function that is called at the end of the stream.

Parameters:

	sd	A pointer to the parsed Stream Descriptor
	ud	A pointer to a user data structure, may be NULL.

See also:

StreamHandler

typedef ErrorCode(* ExceptionHandler)(OobExcept *se, void *ud)

Callback functions that handle exceptions.

Parameters:

	se	A pointer to the parsed Exception
	ud	A pointer to a user data structure, may be NULL.

See also:

StreamHandler

typedef ErrorCode(* CommentHandler)(OobComment *se, void *ud)

Callback functions that handle comments.

Parameters:

	se	A pointer to the parsed Comment
	ud	A pointer to a user data structure, may be NULL.

See also:

StreamHandler