This module contains all of the C submodules. More...
Modules | |
Mip Command Queue [C] | |
Functions for handling command responses. | |
Mip Dispatch [C] | |
System for issuing callbacks from MIP packets or fields. | |
Mip Fields [C] | |
Functions for processing received MIP fields. | |
Mip Interface [C] | |
High-level C functions for controlling a MIP device. | |
Mip Logging [C] | |
High-level C functions for logging information from within the MIP SDK. | |
Mip Packet [C] | |
Functions for handling MIP packets. | |
mip_parser [C] | |
Functions for parsing MIP packets. | |
Typedefs | |
typedef enum mip_cmd_result | mip_cmd_result |
Represents the status of a MIP command. More... | |
Enumerations | |
enum | mip_cmd_result { MIP_STATUS_ERROR = -6, MIP_STATUS_CANCELLED = -5, MIP_STATUS_TIMEDOUT = -4, MIP_STATUS_WAITING = -3, MIP_STATUS_PENDING = -2, MIP_STATUS_NONE = -1, MIP_ACK_OK = 0x00, MIP_NACK_COMMAND_UNKNOWN = 0x01, MIP_NACK_INVALID_CHECKSUM = 0x02, MIP_NACK_INVALID_PARAM = 0x03, MIP_NACK_COMMAND_FAILED = 0x04, MIP_NACK_COMMAND_TIMEOUT = 0x05 } |
Represents the status of a MIP command. More... | |
Functions | |
bool | mip_cmd_result_is_ack (enum mip_cmd_result result) |
Determines if the result is an ack (successful response from the device) More... | |
bool | mip_cmd_result_is_finished (enum mip_cmd_result result) |
Determines if the command has completed, timed out, been cancelled, or otherwise is no longer waiting for a response. More... | |
bool | mip_cmd_result_is_reply (enum mip_cmd_result result) |
Determines if the result is a reply from the device (i.e. More... | |
bool | mip_cmd_result_is_status (enum mip_cmd_result result) |
Determines if the result code was generated by this lib (i.e. More... | |
const char * | mip_cmd_result_to_string (enum mip_cmd_result result) |
Converts the command result to a string for debugging. More... | |
This module contains all of the C submodules.
typedef enum mip_cmd_result mip_cmd_result |
Represents the status of a MIP command.
Values that start with MIP_STATUS are status codes from this library. Values that start with MIP_(N)ACK represent replies from the device.
enum mip_cmd_result |
Represents the status of a MIP command.
Values that start with MIP_STATUS are status codes from this library. Values that start with MIP_(N)ACK represent replies from the device.
Definition at line 23 of file mip_result.h.
bool mip_cmd_result_is_ack | ( | enum mip_cmd_result | result | ) |
Determines if the result is an ack (successful response from the device)
Definition at line 67 of file mip_result.c.
bool mip_cmd_result_is_finished | ( | enum mip_cmd_result | result | ) |
Determines if the command has completed, timed out, been cancelled, or otherwise is no longer waiting for a response.
Definition at line 43 of file mip_result.c.
bool mip_cmd_result_is_reply | ( | enum mip_cmd_result | result | ) |
Determines if the result is a reply from the device (i.e.
mip_ack).
Definition at line 51 of file mip_result.c.
bool mip_cmd_result_is_status | ( | enum mip_cmd_result | result | ) |
Determines if the result code was generated by this lib (i.e.
mip_cmd_status).
Definition at line 59 of file mip_result.c.
const char* mip_cmd_result_to_string | ( | enum mip_cmd_result | result | ) |
Converts the command result to a string for debugging.
result | Any value. |
Definition at line 16 of file mip_result.c.