This module contains all of the C submodules. More...

Collaboration diagram for MIP C API:

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 Packet [C]
	Functions for handling MIP packets.

	mip_parser [C]
	Functions for parsing MIP packets.

Typedefs
typedef enum mip::C::mip_cmd_result	mip::C::mip_cmd_result
	Represents the status of a MIP command. More...

Enumerations
enum	mip::C::mip_cmd_result { mip::C::MIP_STATUS_ERROR = -6 , mip::C::MIP_STATUS_CANCELLED = -5 , mip::C::MIP_STATUS_TIMEDOUT = -4 , mip::C::MIP_STATUS_WAITING = -3 , mip::C::MIP_STATUS_PENDING = -2 , mip::C::MIP_STATUS_NONE = -1 , mip::C::MIP_ACK_OK = 0x00 , mip::C::MIP_NACK_COMMAND_UNKNOWN = 0x01 , mip::C::MIP_NACK_INVALID_CHECKSUM = 0x02 , mip::C::MIP_NACK_INVALID_PARAM = 0x03 , mip::C::MIP_NACK_COMMAND_FAILED = 0x04 , mip::C::MIP_NACK_COMMAND_TIMEOUT = 0x05 }
	Represents the status of a MIP command. More...

Functions
const char *	mip::C::mip_cmd_result_to_string (enum mip_cmd_result result)

bool	mip::C::mip_cmd_result_is_finished (enum mip_cmd_result result)

bool	mip::C::mip_cmd_result_is_reply (enum mip_cmd_result result)

bool	mip::C::mip_cmd_result_is_status (enum mip_cmd_result result)

bool	mip::C::mip_cmd_result_is_ack (enum mip_cmd_result result)

Detailed Description

This module contains all of the C submodules.

Typedef Documentation

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.

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.

Enumerator
MIP_STATUS_ERROR	Command could not be executed (error sending/receiving)
MIP_STATUS_CANCELLED	Command was canceled in software.
MIP_STATUS_TIMEDOUT	Reply was not received before timeout expired.
MIP_STATUS_WAITING	Waiting for command reply (timeout timer has started).
MIP_STATUS_PENDING	Command has been queued but the I/O update hasn't run yet.
MIP_STATUS_NONE	Command has been initialized but not queued yet.
MIP_ACK_OK	Command completed successfully.
MIP_NACK_COMMAND_UNKNOWN	Command not supported.
MIP_NACK_INVALID_CHECKSUM	Reserved.
MIP_NACK_INVALID_PARAM	A parameter was not a supported value.
MIP_NACK_COMMAND_FAILED	The device could not complete the command.
MIP_NACK_COMMAND_TIMEOUT	Internal device timeout. Use MIP_STATUS_TIMEDOUT for command timeouts.

bool mip::C::mip_cmd_result_is_ack ( enum mip_cmd_result result )

bool mip::C::mip_cmd_result_is_finished ( enum mip_cmd_result result )

bool mip::C::mip_cmd_result_is_reply ( enum mip_cmd_result result )

bool mip::C::mip_cmd_result_is_status ( enum mip_cmd_result result )

const char* mip::C::mip_cmd_result_to_string ( enum mip_cmd_result result )