mip_pending_cmd Struct Reference

Represents a command awaiting a reply from the device. More...

#include <mip_cmdqueue.h>

Public Attributes
union {
timeout_type   _extra_timeout
	< More...
timestamp_type   _reply_time
	If MIP_STATUS_COMPLETED: timestamp_type from the packet containing the ack/nack. More...
timestamp_type   _timeout_time
	If MIP_STATUS_WAITING: timestamp_type after which the command will be timed out. More...
};

Private Attributes
union {
uint8_t   _response_buffer_size
	If status < MIP_STATUS_COMPLETED, the size of the reply data buffer. More...
uint8_t   _response_length
	If status == MIP_STATUS_COMPLETED, the length of the reply data. More...
};
uint8_t	_descriptor_set
	Command descriptor set. More...
uint8_t	_field_descriptor
	Command field descriptor. More...
struct mip_pending_cmd *	_next
	Next command in the queue. More...
uint8_t *	_response_buffer
	Buffer for response data if response_descriptor != 0x00. More...
uint8_t	_response_descriptor
	Response field descriptor, or 0x00 if no response field expected. More...
enum mip_cmd_result	_status
	The current status of the command. Writing this to any MipAck value may cause deallocation. More...

Detailed Description

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.

Definition at line 41 of file mip_cmdqueue.h.

Member Data Documentation

@55

union { ... }

@57

union { ... }

_descriptor_set

uint8_t mip_pending_cmd::_descriptor_set

private

Command descriptor set.

Definition at line 50 of file mip_cmdqueue.h.

_extra_timeout

timeout_type mip_pending_cmd::_extra_timeout

private

<

If MIP_STATUS_PENDING: Duration to wait for reply, excluding base timeout time from the queue object.

Definition at line 46 of file mip_cmdqueue.h.

_field_descriptor

uint8_t mip_pending_cmd::_field_descriptor

private

Command field descriptor.

Definition at line 51 of file mip_cmdqueue.h.

_next

struct mip_pending_cmd* mip_pending_cmd::_next

private

Next command in the queue.

Definition at line 43 of file mip_cmdqueue.h.

_reply_time

timestamp_type mip_pending_cmd::_reply_time

private

If MIP_STATUS_COMPLETED: timestamp_type from the packet containing the ack/nack.

Definition at line 48 of file mip_cmdqueue.h.

_response_buffer

uint8_t* mip_pending_cmd::_response_buffer

private

Buffer for response data if response_descriptor != 0x00.

Definition at line 44 of file mip_cmdqueue.h.

_response_buffer_size

uint8_t mip_pending_cmd::_response_buffer_size

private

If status < MIP_STATUS_COMPLETED, the size of the reply data buffer.

Definition at line 54 of file mip_cmdqueue.h.

_response_descriptor

uint8_t mip_pending_cmd::_response_descriptor

private

Response field descriptor, or 0x00 if no response field expected.

Definition at line 52 of file mip_cmdqueue.h.

_response_length

uint8_t mip_pending_cmd::_response_length

private

If status == MIP_STATUS_COMPLETED, the length of the reply data.

Definition at line 55 of file mip_cmdqueue.h.

_status

enum mip_cmd_result mip_pending_cmd::_status

private

The current status of the command. Writing this to any MipAck value may cause deallocation.

Definition at line 57 of file mip_cmdqueue.h.

_timeout_time

timestamp_type mip_pending_cmd::_timeout_time

private

If MIP_STATUS_WAITING: timestamp_type after which the command will be timed out.

Definition at line 47 of file mip_cmdqueue.h.

---

The documentation for this struct was generated from the following file:

• mip_cmdqueue.h