libdas2
das2 core C utilities
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Structures | Typedefs
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 DasErrCode(* StreamDescHandler )(StreamDesc *sd, void *ud)
 Definition of the callback function invoked when a stream header is encountered in the input. More...
 
typedef DasErrCode(* PktDescHandler )(StreamDesc *sd, PktDesc *pd, void *ud)
 Definition of the callback function invoked when a packet header is encountered in the input. More...
 
typedef DasErrCode(* PktRedefHandler )(StreamDesc *sd, PktDesc *pd, void *ud)
 Definition of the callback function invoked when a packet header is going to be deleted. More...
 
typedef DasErrCode(* PktDataHandler )(PktDesc *pd, void *ud)
 Callback function invoked when a data packet is encountered in the input. More...
 
typedef DasErrCode(* CloseHandler )(StreamDesc *sd, void *ud)
 Callback functions that invoked on Stream Close callback function that is called at the end of the stream. More...
 
typedef DasErrCode(* ExceptionHandler )(OobExcept *se, void *ud)
 Callback functions that handle exceptions. More...
 
typedef DasErrCode(* CommentHandler )(OobComment *se, void *ud)
 Callback functions that handle comments. More...
 

Typedef Documentation

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

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

Parameters
sdA pointer to the parsed StreamDesc
pdA pointer to a user data structure, may be NULL.
See Also
StreamHandler
typedef DasErrCode(* PktDescHandler)(StreamDesc *sd, PktDesc *pd, void *ud)

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

Parameters
sdA pointer to the parsed Stream Descriptor
pdA pointer to the parsed Packet Descriptor
udA pointer to a user data structure, may be NULL.
See Also
StreamHandler
typedef DasErrCode(* PktRedefHandler)(StreamDesc *sd, PktDesc *pd, void *ud)

Definition of the callback function invoked when a packet header is going to be deleted.

This only occurs if streams re-define packet IDs

Parameters
@paramsd A pointer to the parsed Stream Descriptor
pdA pointer to the parsed Packet Descriptor
udA pointer to a user data structure, may be NULL.
See Also
StreamHandler
typedef DasErrCode(* PktDataHandler)(PktDesc *pd, void *ud)

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

Parameters
sdA pointer to the parsed Packet Descriptor
udA pointer to a user data structure, may be NULL.
See Also
StreamHandler
typedef DasErrCode(* CloseHandler)(StreamDesc *sd, void *ud)

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

Parameters
sdA pointer to the parsed Stream Descriptor
udA pointer to a user data structure, may be NULL.
See Also
StreamHandler
typedef DasErrCode(* ExceptionHandler)(OobExcept *se, void *ud)

Callback functions that handle exceptions.

Parameters
seA pointer to the parsed Exception
udA pointer to a user data structure, may be NULL.
See Also
StreamHandler
typedef DasErrCode(* CommentHandler)(OobComment *se, void *ud)

Callback functions that handle comments.

Parameters
seA pointer to the parsed Comment
udA pointer to a user data structure, may be NULL.
See Also
StreamHandler