MIP SDK  0.0.1
MicroStrain Communications Library for embedded systems
Classes | Typedefs | Functions
mip_pending_cmd functions [C]
Collaboration diagram for mip_pending_cmd functions [C]:

Classes

struct  mip::C::mip_pending_cmd
 Represents a command awaiting a reply from the device. More...
 

Typedefs

typedef struct mip::C::mip_pending_cmd mip::C::mip_pending_cmd
 Represents a command awaiting a reply from the device. More...
 

Functions

void mip::C::mip_pending_cmd_init (mip_pending_cmd *cmd, uint8_t descriptor_set, uint8_t field_descriptor)
 
void mip::C::mip_pending_cmd_init_with_timeout (mip_pending_cmd *cmd, uint8_t descriptor_set, uint8_t field_descriptor, timeout_type additional_time)
 
void mip::C::mip_pending_cmd_init_with_response (mip_pending_cmd *cmd, uint8_t descriptor_set, uint8_t field_descriptor, uint8_t response_descriptor, uint8_t *response_buffer, uint8_t response_buffer_size)
 
void mip::C::mip_pending_cmd_init_full (mip_pending_cmd *cmd, uint8_t descriptor_set, uint8_t field_descriptor, uint8_t response_descriptor, uint8_t *response_buffer, uint8_t response_size, timeout_type additional_time)
 
enum mip_cmd_result mip::C::mip_pending_cmd_status (const mip_pending_cmd *cmd)
 
const uint8_t * mip::C::mip_pending_cmd_response (const mip_pending_cmd *cmd)
 
uint8_t mip::C::mip_pending_cmd_response_length (const mip_pending_cmd *cmd)
 
bool mip::C::mip_pending_cmd_check_timeout (const mip_pending_cmd *cmd, timestamp_type now)
 

Detailed Description

Typedef Documentation

◆ mip_pending_cmd

Represents a command awaiting a reply from the device.

Note
This should be considered an "opaque" structure; its members should be considered an internal implementation detail. Avoid accessing them directly as they are subject to change in future versions of this software.

Function Documentation

◆ mip_pending_cmd_check_timeout()

bool mip::C::mip_pending_cmd_check_timeout ( const mip_pending_cmd cmd,
timestamp_type  now 
)

◆ mip_pending_cmd_init()

void mip::C::mip_pending_cmd_init ( mip_pending_cmd cmd,
uint8_t  descriptor_set,
uint8_t  field_descriptor 
)

◆ mip_pending_cmd_init_full()

void mip::C::mip_pending_cmd_init_full ( mip_pending_cmd cmd,
uint8_t  descriptor_set,
uint8_t  field_descriptor,
uint8_t  response_descriptor,
uint8_t *  response_buffer,
uint8_t  response_size,
timeout_type  additional_time 
)

◆ mip_pending_cmd_init_with_response()

void mip::C::mip_pending_cmd_init_with_response ( mip_pending_cmd cmd,
uint8_t  descriptor_set,
uint8_t  field_descriptor,
uint8_t  response_descriptor,
uint8_t *  response_buffer,
uint8_t  response_buffer_size 
)

◆ mip_pending_cmd_init_with_timeout()

void mip::C::mip_pending_cmd_init_with_timeout ( mip_pending_cmd cmd,
uint8_t  descriptor_set,
uint8_t  field_descriptor,
timeout_type  additional_time 
)

◆ mip_pending_cmd_response()

const uint8_t* mip::C::mip_pending_cmd_response ( const mip_pending_cmd cmd)

◆ mip_pending_cmd_response_length()

uint8_t mip::C::mip_pending_cmd_response_length ( const mip_pending_cmd cmd)

◆ mip_pending_cmd_status()

enum mip_cmd_result mip::C::mip_pending_cmd_status ( const mip_pending_cmd cmd)