mip_cmdqueue.h File Reference

#include <stdint.h>
#include "mip_types.h"
#include "mip_result.h"
#include "mip_packet.h"

Go to the source code of this file.

Classes
struct	mip::C::mip_pending_cmd
	Represents a command awaiting a reply from the device. More...
struct	mip::C::mip_cmd_queue
	Holds a list of pending commands. More...

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

Typedefs
typedef struct mip::C::mip_pending_cmd	mip::C::mip_pending_cmd
	Represents a command awaiting a reply from the device. More...
typedef struct mip::C::mip_cmd_queue	mip::C::mip_cmd_queue
	Holds a list of pending commands. More...

Functions
void	mip::C::mip_pending_cmd_init (mip_pending_cmd *cmd, uint8_t descriptor_set, uint8_t field_descriptor)
	Initialize a pending command with no reponse data or additional time. More...
void	mip::C::mip_pending_cmd_init_with_timeout (mip_pending_cmd *cmd, uint8_t descriptor_set, uint8_t field_descriptor, mip_timeout additional_time)
	Initialize a pending mip commmand with extra timeout time. More...
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)
	Initialize a pending mip commmand with expected response data. More...
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_buffer_size, mip_timeout additional_time)
	Initialize a pending mip commmand with all parameters. More...
enum mip_cmd_result	mip::C::mip_pending_cmd_status (const mip_pending_cmd *cmd)
	Returns the status of the pending command. More...
uint8_t	mip::C::mip_pending_cmd_response_descriptor (const mip_pending_cmd *cmd)
	Returns the response descriptor. More...
const uint8_t *	mip::C::mip_pending_cmd_response (const mip_pending_cmd *cmd)
	Returns the response payload pointer. More...
uint8_t	mip::C::mip_pending_cmd_response_length (const mip_pending_cmd *cmd)
	Returns the length of the response data. More...
int	mip::C::mip_pending_cmd_remaining_time (const mip_pending_cmd *cmd, mip_timestamp now)
	Determines how much time is remaining before the command times out. More...
bool	mip::C::mip_pending_cmd_check_timeout (const mip_pending_cmd *cmd, mip_timestamp now)
	Checks if the command should time out. More...
void	mip::C::mip_cmd_queue_init (mip_cmd_queue *queue, mip_timeout base_reply_timeout)
	Initializes a command queue. More...
void	mip::C::mip_cmd_queue_enqueue (mip_cmd_queue *queue, mip_pending_cmd *cmd)
	Queue a command to wait for replies. More...
void	mip::C::mip_cmd_queue_dequeue (mip_cmd_queue *queue, mip_pending_cmd *cmd)
	Removes a pending command from the queue. More...
void	mip::C::mip_cmd_queue_clear (mip_cmd_queue *queue)
	Clears the command queue. More...
void	mip::C::mip_cmd_queue_update (mip_cmd_queue *queue, mip_timestamp now)
	Call periodically to make sure commands time out if no packets are received. More...
void	mip::C::mip_cmd_queue_set_base_reply_timeout (mip_cmd_queue *queue, mip_timeout timeout)
	Sets the base reply timeout for all commands. More...
mip_timeout	mip::C::mip_cmd_queue_base_reply_timeout (const mip_cmd_queue *queue)
	Gets the base reply timeout for all commands. More...
void	mip::C::mip_cmd_queue_process_packet (mip_cmd_queue *queue, const mip_packet_view *packet, mip_timestamp timestamp)
	Process an incoming packet and check for replies to pending commands. More...