ipc_mqtt

MQTT messaging service. More...

Data Structures
struct	a_ipc_msg_mqtt_shoulder_tap_publish_ind
	Shoulder tap message received. More...
struct	a_ipc_msg_mqtt_shoulder_tap_subscribe_req
	Subscribe to updates for mqtt_shoulder_tap. More...
struct	a_ipc_msg_mqtt_shoulder_tap_subscribe_rsp
	Sent in response to a_ipc_msg_mqtt_shoulder_tap_subscribe_req. More...
struct	a_ipc_msg_mqtt_shoulder_tap_unsubscribe_req_norsp
	Unsubscribe from updates for mqtt_shoulder_tap. More...

Functions
A_IPC_RESULT	a_ipc_init_mqtt_shoulder_tap_publish_ind (a_ipc_msg *msg, uint32_t target_uuid_maxlength, uint32_t payload_maxlength)
	Initialize the message buffer to contain a_ipc_msg_mqtt_shoulder_tap_publish_ind. More...
A_IPC_RESULT	a_ipc_init_mqtt_shoulder_tap_subscribe_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_mqtt_shoulder_tap_subscribe_req. More...
A_IPC_RESULT	a_ipc_init_mqtt_shoulder_tap_subscribe_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_mqtt_shoulder_tap_subscribe_rsp. More...
A_IPC_RESULT	a_ipc_init_mqtt_shoulder_tap_unsubscribe_req_norsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_mqtt_shoulder_tap_unsubscribe_req_norsp. More...

Detailed Description

MQTT messaging service.

This page contains documentation for receiving various messages from the Actia Device Manager.

---

Data Structure Documentation

a_ipc_msg_mqtt_shoulder_tap_publish_ind

struct a_ipc_msg_mqtt_shoulder_tap_publish_ind

Shoulder tap message received.

Direction: server to client

Subscribe using a_ipc_msg_mqtt_shoulder_tap_subscribe_req and unsubscribe using a_ipc_msg_mqtt_shoulder_tap_unsubscribe_req_norsp.

Create using a_ipc_init_mqtt_shoulder_tap_publish_ind().

Message type is A_IPC_MSG_MQTT_SHOULDER_TAP_PUBLISH_IND.

Data Fields
a_ipc_dyn_array_uint8	payload	Optional extra content of the message.
a_ipc_dyn_string	target_uuid	Target uuid, up to user application to define its meaning.

a_ipc_msg_mqtt_shoulder_tap_subscribe_req

struct a_ipc_msg_mqtt_shoulder_tap_subscribe_req

Subscribe to updates for mqtt_shoulder_tap.

a_ipc_msg_mqtt_shoulder_tap_publish_ind will be received until a_ipc_msg_mqtt_shoulder_tap_unsubscribe_req_norsp is sent.

Response is delivered in a_ipc_msg_mqtt_shoulder_tap_subscribe_rsp.

Create using a_ipc_init_mqtt_shoulder_tap_subscribe_req().

Message type is A_IPC_MSG_MQTT_SHOULDER_TAP_SUBSCRIBE_REQ.

a_ipc_msg_mqtt_shoulder_tap_subscribe_rsp

struct a_ipc_msg_mqtt_shoulder_tap_subscribe_rsp

Sent in response to a_ipc_msg_mqtt_shoulder_tap_subscribe_req.

Create using a_ipc_init_mqtt_shoulder_tap_subscribe_rsp().

Message type is A_IPC_MSG_MQTT_SHOULDER_TAP_SUBSCRIBE_RSP.

Data Fields
a_ipc_enum_ipc_subscribe_result	result	The result of the subscription request.

a_ipc_msg_mqtt_shoulder_tap_unsubscribe_req_norsp

struct a_ipc_msg_mqtt_shoulder_tap_unsubscribe_req_norsp

Unsubscribe from updates for mqtt_shoulder_tap.

a_ipc_msg_mqtt_shoulder_tap_publish_ind will no longer be received.

Create using a_ipc_init_mqtt_shoulder_tap_unsubscribe_req_norsp().

Message type is A_IPC_MSG_MQTT_SHOULDER_TAP_UNSUBSCRIBE_REQ_NORSP.

Function Documentation

a_ipc_init_mqtt_shoulder_tap_publish_ind()

A_IPC_RESULT a_ipc_init_mqtt_shoulder_tap_publish_ind	(	a_ipc_msg *	msg,
		uint32_t	target_uuid_maxlength,
		uint32_t	payload_maxlength
	)

Initialize the message buffer to contain a_ipc_msg_mqtt_shoulder_tap_publish_ind.

msg->info.type will be A_IPC_MSG_MQTT_SHOULDER_TAP_PUBLISH_IND.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize
target_uuid_maxlength	The maximum string length for target_uuid in the message.
payload_maxlength	The number of array elements to reserve for payload in the message.

a_ipc_init_mqtt_shoulder_tap_subscribe_req()

A_IPC_RESULT a_ipc_init_mqtt_shoulder_tap_subscribe_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_mqtt_shoulder_tap_subscribe_req.

msg->info.type will be A_IPC_MSG_MQTT_SHOULDER_TAP_SUBSCRIBE_REQ.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_mqtt_shoulder_tap_subscribe_rsp()

A_IPC_RESULT a_ipc_init_mqtt_shoulder_tap_subscribe_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_mqtt_shoulder_tap_subscribe_rsp.

msg->info.type will be A_IPC_MSG_MQTT_SHOULDER_TAP_SUBSCRIBE_RSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_mqtt_shoulder_tap_unsubscribe_req_norsp()

A_IPC_RESULT a_ipc_init_mqtt_shoulder_tap_unsubscribe_req_norsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_mqtt_shoulder_tap_unsubscribe_req_norsp.

msg->info.type will be A_IPC_MSG_MQTT_SHOULDER_TAP_UNSUBSCRIBE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

Variable Documentation

payload

a_ipc_dyn_array_uint8 a_ipc_msg_mqtt_shoulder_tap_publish_ind::payload

Optional extra content of the message.

result

a_ipc_enum_ipc_subscribe_result a_ipc_msg_mqtt_shoulder_tap_subscribe_rsp::result

The result of the subscription request.

target_uuid

a_ipc_dyn_string a_ipc_msg_mqtt_shoulder_tap_publish_ind::target_uuid

Target uuid, up to user application to define its meaning.