Application event decoders

Application event decoders. More...

Functions
uint32_t	ble_evt_tx_complete_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_evt_tx_complete event. More...
uint32_t	ble_evt_user_mem_request_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_evt_user_mem_request event. More...
uint32_t	ble_evt_user_mem_release_dec (uint8_t const *const p_buf, uint32_t packet_len, ble_evt_t *const p_event, uint32_t *const p_event_len)
	Decodes ble_evt_user_mem_release event. More...

Detailed Description

Application event decoders.

Function Documentation

uint32_t ble_evt_tx_complete_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_evt_tx_complete event.

See Also

0x01 - BLE_EVT_TX_COMPLETE for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.

uint32_t ble_evt_user_mem_release_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_evt_user_mem_release event.

See Also

0x03 - BLE_EVT_USER_MEM_RELEASE for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.

uint32_t ble_evt_user_mem_request_dec	(	uint8_t const *const	p_buf,
		uint32_t	packet_len,
		ble_evt_t *const	p_event,
		uint32_t *const	p_event_len
	)

Decodes ble_evt_user_mem_request event.

See Also

0x02 - BLE_EVT_USER_MEM_REQUEST for packet format.

If p_event is null, the required length of p_event is returned in p_event_len.

Parameters

[in]	p_buf	Pointer to the beginning of an event packet.
[in]	packet_len	Length (in bytes) of the event packet.
[in,out]	p_event	Pointer to a ble_evt_t buffer where the decoded event will be stored. If NULL, required length will be returned in p_event_len.
[in,out]	p_event_len	in: Size (in bytes) of p_event buffer. out: Length of decoded contents of p_event.

Return values

NRF_SUCCESS	Decoding success.
NRF_ERROR_NULL	Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH	Decoding failure. Incorrect buffer length.
NRF_ERROR_DATA_SIZE	Decoding failure. Length of p_event is too small to hold decoded event.