GAP Application event decoders

nRF5 SDK v12.2.0
Functions

GAP Application event decoders. More...

Functions

uint32_t ble_gap_evt_auth_key_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_gap_evt_auth_key_request event. More...
uint32_t ble_gap_evt_auth_status_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_gap_evt_auth_status event. More...
uint32_t ble_gap_evt_conn_param_update_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_gap_evt_conn_param_update event. More...
uint32_t ble_gap_evt_conn_sec_update_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_gap_evt_conn_sec_update event. More...
uint32_t ble_gap_evt_connected_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_gap_evt_connected event. More...
uint32_t ble_gap_evt_disconnected_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_gap_evt_disconnected event. More...
uint32_t ble_gap_evt_passkey_display_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_gap_evt_passkey_display event. More...
uint32_t ble_gap_evt_rssi_changed_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_gap_evt_rssi_changed event. More...
uint32_t ble_gap_evt_sec_info_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_gap_evt_sec_info_request event. More...
uint32_t ble_gap_evt_sec_params_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_gap_evt_sec_params_request event. More...
uint32_t ble_gap_evt_timeout_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_gap_evt_timeout event. More...
uint32_t ble_gap_evt_sec_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_gap_evt_sec_request event. More...
uint32_t ble_gap_evt_conn_param_update_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_gap_evt_conn_param_update_request event. More...
uint32_t ble_gap_evt_adv_report_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_gap_evt_adv_report event. More...
uint32_t ble_gap_evt_scan_req_report_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_gap_evt_scan_req_report event. More...
uint32_t ble_gap_evt_key_pressed_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_gap_evt_key_pressed event. More...
uint32_t ble_gap_evt_lesc_dhkey_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_gap_evt_lesc_dhkey_request event. More...

Detailed Description

GAP Application event decoders.

Function Documentation

uint32_t ble_gap_evt_adv_report_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_gap_evt_adv_report event.

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_gap_evt_auth_key_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_gap_evt_auth_key_request event.

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_gap_evt_auth_status_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_gap_evt_auth_status event.

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_gap_evt_conn_param_update_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_gap_evt_conn_param_update event.

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_gap_evt_conn_param_update_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_gap_evt_conn_param_update_request event.

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_gap_evt_conn_sec_update_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_gap_evt_conn_sec_update event.

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_gap_evt_connected_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_gap_evt_connected event.

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_gap_evt_disconnected_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_gap_evt_disconnected event.

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_gap_evt_key_pressed_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_gap_evt_key_pressed event.

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_gap_evt_lesc_dhkey_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_gap_evt_lesc_dhkey_request event.

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_gap_evt_passkey_display_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_gap_evt_passkey_display event.

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_gap_evt_rssi_changed_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_gap_evt_rssi_changed event.

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_gap_evt_scan_req_report_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_gap_evt_scan_req_report event.

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_gap_evt_sec_info_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_gap_evt_sec_info_request event.

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_gap_evt_sec_params_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_gap_evt_sec_params_request event.

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_gap_evt_sec_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_gap_evt_sec_request event.

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_gap_evt_timeout_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_gap_evt_timeout event.

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.