Data Dispatch

System for issuing callbacks from MIP packets or fields. More...

Modules
	Dispatch Handler
	This represents a binding between a MIP descriptor pair and a callback function.
	Mip Dispatcher
	This is included in the Mip Interface to allow the registration of callbacks.

Typedefs
typedef void(*	mip::C::mip_dispatch_packet_callback) (void *context, const mip_packet_view *packet, mip_timestamp timestamp)
	Signature for packet-level callbacks. More...
typedef void(*	mip::C::mip_dispatch_field_callback) (void *context, const mip_field_view *field, mip_timestamp timestamp)
	Signature for field-level callbacks. More...
typedef bool(*	mip::C::mip_dispatch_extractor) (const mip_field_view *field, void *ptr)
	Signature for extraction callbacks. More...

Enumerations
enum	{ mip::C::MIP_DISPATCH_ANY_DATA_SET = 0xFF, mip::C::MIP_DISPATCH_ANY_DESCRIPTOR = 0x00 }

Detailed Description

System for issuing callbacks from MIP packets or fields.

The user's application may register handlers in the dispatcher to receive callbacks for reception of various types of data. Packets, fields, and deserialized data callbacks may be registered.

See also

mip_dispatch

Typedef Documentation

mip_dispatch_extractor

typedef bool(* mip::C::mip_dispatch_extractor) (const mip_field_view *field, void *ptr)

Signature for extraction callbacks.

Parameters

field	A valid mip_field.
ptr	A pointer to the destination field structure.

mip_dispatch_field_callback

typedef void(* mip::C::mip_dispatch_field_callback) (void *context, const mip_field_view *field, mip_timestamp timestamp)

Signature for field-level callbacks.

Parameters

context	User-supplied data pointer.
field	The MIP field triggering this callback.
timestamp	The approximate parse time of the packet.

mip_dispatch_packet_callback

typedef void(* mip::C::mip_dispatch_packet_callback) (void *context, const mip_packet_view *packet, mip_timestamp timestamp)

Signature for packet-level callbacks.

Parameters

context	User-supplied data pointer.
packet	The MIP packet triggering this callback.
timestamp	The approximate parse time of the packet.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
MIP_DISPATCH_ANY_DATA_SET	Wildcard descriptor set which only includes data packets. Note This is the same value as shared data descriptor set, but the shared data descriptor set is not real and will never be sent by the device.
MIP_DISPATCH_ANY_DESCRIPTOR	Any descriptor set or field descriptor. This is not a valid MIP descriptor.