Reliable messages

Reliable message sending for the access layer. More...

Modules
	Message sequence charts
	Defines
	Access reliable message defines.
	Types
	Access reliable message types.

Functions
void	access_reliable_init (void)
	Initializes the reliable publication framework.
void	access_reliable_cancel_all (void)
	Cancels all ongoing transfers. More...
uint32_t	access_model_reliable_publish (const access_reliable_t *p_reliable)
	Starts publishing a reliable message. More...
uint32_t	access_model_reliable_cancel (access_model_handle_t model_handle)
	Cancels an ongoing reliable message. More...
void	access_reliable_message_rx_cb (access_model_handle_t model_handle, const access_message_rx_t *p_message, void *p_args)
	Callback called by access layer when a model receives a message. More...

Detailed Description

Reliable message sending for the access layer.

Function Documentation

access_reliable_cancel_all()

void access_reliable_cancel_all

(

void

)

Cancels all ongoing transfers.

Warning

This will not notify the about the canceled transfer. Thus calling this function in the middle of a reliable transfer may cause unexpected behavior for the affected models.

access_model_reliable_publish()

uint32_t access_model_reliable_publish

(

const access_reliable_t *

p_reliable

)

Starts publishing a reliable message.

Parameters

[in]

p_reliable

Reliable message parameter structure pointer.

Return values

NRF_SUCCESS	Successfully started the reliable message publication.
NRF_ERROR_NULL	NULL pointer given to function.
NRF_ERROR_NO_MEM	No memory available to send the message at this point.
NRF_ERROR_NOT_FOUND	Invalid model handle or model not bound to element.
NRF_ERROR_INVALID_PARAM	Model not bound to application key, publish address not set or wrong opcode format.
NRF_ERROR_INVALID_STATE	Message already scheduled for a reliable transfer.
NRF_ERROR_INVALID_LENGTH	Attempted to send message larger than ACCESS_MESSAGE_LENGTH_MAX.

access_model_reliable_cancel()

uint32_t access_model_reliable_cancel

(

access_model_handle_t

model_handle

)

Cancels an ongoing reliable message.

Parameters

[in]

model_handle

Access layer model handle that owns the transfer.

Return values

NRF_SUCCESS	Successfully canceled the reliable message.
NRF_ERROR_NOT_FOUND	No active reliable message for given handle.
NRF_ERROR_NOT_FOUND	Invalid model handle or model not bound to element.

access_reliable_message_rx_cb()

void access_reliable_message_rx_cb	(	access_model_handle_t	model_handle,
		const access_message_rx_t *	p_message,
		void *	p_args
	)

Callback called by access layer when a model receives a message.

Parameters

[in]	model_handle	Model handle that received the message
[in]	p_message	Message pointer.
[in]	p_args	Generic argument pointer for the model.