MIP_SDK  latest-2-g34f3e39
MicroStrain Communications Library for embedded systems
Classes | Namespaces | Typedefs | Enumerations | Functions
mip_dispatch.h File Reference
#include "mip_types.h"
#include "mip_field.h"
#include "mip_packet.h"
#include "mip_descriptors.h"
#include <stdbool.h>

Go to the source code of this file.

Classes

struct  mip::C::mip_dispatch_handler
 Handler information for MIP Packet or Field callbacks. More...
 
struct  mip::C::mip_dispatcher
 Holds the state of the MIP dispatch system. More...
 

Namespaces

 mip
 A collection of C++ classes and functions covering the full mip api.
 
 mip::C
 

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...
 
typedef struct mip::C::mip_dispatch_handler mip::C::mip_dispatch_handler
 Handler information for MIP Packet or Field callbacks. More...
 
typedef struct mip::C::mip_dispatcher mip::C::mip_dispatcher
 Holds the state of the MIP dispatch system. More...
 

Enumerations

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

Functions

void mip::C::mip_dispatch_handler_init_packet_handler (mip_dispatch_handler *handler, uint8_t descriptor_set, bool post_callback, mip_dispatch_packet_callback callback, void *user_data)
 Initialize the dispatch handler with a packet callback. More...
 
void mip::C::mip_dispatch_handler_init_field_handler (mip_dispatch_handler *handler, uint8_t descriptor_set, uint8_t field_descriptor, mip_dispatch_field_callback callback, void *user_data)
 Initialize the dispatch handler with a field callback. More...
 
void mip::C::mip_dispatch_handler_init_extractor (mip_dispatch_handler *handler, uint8_t descriptor_set, uint8_t field_descriptor, mip_dispatch_extractor extractor, void *field_ptr)
 Initialize the dispatch handler with an extraction callback. More...
 
void mip::C::mip_dispatch_handler_set_enabled (mip_dispatch_handler *handler, bool enable)
 Enables or disables the handler. More...
 
bool mip::C::mip_dispatch_handler_is_enabled (mip_dispatch_handler *handler)
 Determines if the handler is currently enabled. More...
 
void mip::C::mip_dispatcher_init (mip_dispatcher *self)
 Initializes the mip_dispatcher object. More...
 
void mip::C::mip_dispatcher_add_handler (mip_dispatcher *self, mip_dispatch_handler *handler)
 Registers a handler in the dispatch system. More...
 
void mip::C::mip_dispatcher_remove_handler (mip_dispatcher *self, mip_dispatch_handler *handler)
 Removes a handler from the dispatch system. More...
 
void mip::C::mip_dispatcher_remove_all_handlers (mip_dispatcher *self)
 Removes all handlers from the dispatcher. More...
 
void mip::C::mip_dispatcher_dispatch_packet (mip_dispatcher *self, const mip_packet_view *packet, mip_timestamp timestamp)
 Called to dispatch the callbacks for a given packet. More...