MIP SDK  0.0.1
MicroStrain Communications Library for embedded systems
Modules | Typedefs | Enumerations
Mip Dispatch [C]

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

Collaboration diagram for Mip Dispatch [C]:

Modules

 mip_dispatch_handler
 
 mip_dispatch_handler - Represents a callback
 

Typedefs

typedef void(* mip::C::mip_dispatch_packet_callback) (void *context, const mip_packet *packet, timestamp_type timestamp)
 Signature for packet-level callbacks. More...
 
typedef void(* mip::C::mip_dispatch_field_callback) (void *context, const mip_field *field, timestamp_type timestamp)
 Signature for field-level callbacks. More...
 
typedef bool(* mip::C::mip_dispatch_extractor) (const mip_field *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.

Typedef Documentation

◆ mip_dispatch_extractor

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

Signature for extraction callbacks.

Parameters
fieldA valid mip_field.
ptrA pointer to the destination field structure.

◆ mip_dispatch_field_callback

typedef void(* mip::C::mip_dispatch_field_callback) (void *context, const mip_field *field, timestamp_type timestamp)

Signature for field-level callbacks.

Parameters
contextUser-supplied data pointer.
fieldThe MIP field triggering this callback.
timestampThe approximate parse time of the packet.

◆ mip_dispatch_packet_callback

typedef void(* mip::C::mip_dispatch_packet_callback) (void *context, const mip_packet *packet, timestamp_type timestamp)

Signature for packet-level callbacks.

Parameters
contextUser-supplied data pointer.
packetThe MIP packet triggering this callback.
timestampThe 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.