GAP Connectivity event encoders

nRF5 SDK v12.1.0

GAP Connectivity event encoders. More...

Functions

uint32_t ble_gap_evt_auth_key_request_enc ( ble_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes ble_gap_evt_auth_key_request event. More...
uint32_t ble_gap_evt_auth_status_enc ( ble_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes ble_gap_evt_auth_status event. More...
uint32_t ble_gap_evt_conn_param_update_enc ( ble_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes ble_gap_evt_conn_param_update event. More...
uint32_t ble_gap_evt_conn_sec_update_enc ( ble_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes ble_gap_evt_conn_sec_update event. More...
uint32_t ble_gap_evt_connected_enc ( ble_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes ble_gap_evt_connected event. More...
uint32_t ble_gap_evt_disconnected_enc ( ble_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes ble_gap_evt_disconnected event. More...
uint32_t ble_gap_evt_passkey_display_enc ( ble_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes ble_gap_evt_passkey_display event. More...
uint32_t ble_gap_evt_rssi_changed_enc ( ble_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes ble_gap_evt_rssi_changed event. More...
uint32_t ble_gap_evt_sec_info_request_enc ( ble_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes ble_gap_evt_sec_info_request event. More...
uint32_t ble_gap_evt_sec_params_request_enc ( ble_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes ble_gap_evt_sec_params_request event. More...
uint32_t ble_gap_evt_timeout_enc ( ble_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes ble_gap_evt_timeout event. More...
uint32_t ble_gap_evt_sec_request_enc ( ble_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes ble_gap_evt_sec_request event. More...
uint32_t ble_gap_evt_conn_param_update_request_enc ( ble_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes ble_gap_evt_conn_param_update_request event. More...
uint32_t ble_gap_evt_adv_report_enc ( ble_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes ble_gap_evt_adv_report event. More...
uint32_t ble_gap_evt_scan_req_report_enc ( ble_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes ble_gap_evt_scan_req_report event. More...
uint32_t ble_gap_evt_key_pressed_enc ( ble_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes ble_gap_evt_key_pressed event. More...
uint32_t ble_gap_evt_lesc_dhkey_request_enc ( ble_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes ble_gap_evt_lesc_dhkey_request event. More...

Detailed Description

GAP Connectivity event encoders.

Function Documentation

uint32_t ble_gap_evt_adv_report_enc ( ble_evt_t const *const p_event ,
uint32_t event_len ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes ble_gap_evt_adv_report event.

Parameters
[in] p_event Pointer to the ble_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
uint32_t ble_gap_evt_auth_key_request_enc ( ble_evt_t const *const p_event ,
uint32_t event_len ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes ble_gap_evt_auth_key_request event.

Parameters
[in] p_event Pointer to the ble_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
uint32_t ble_gap_evt_auth_status_enc ( ble_evt_t const *const p_event ,
uint32_t event_len ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes ble_gap_evt_auth_status event.

Parameters
[in] p_event Pointer to the ble_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
uint32_t ble_gap_evt_conn_param_update_enc ( ble_evt_t const *const p_event ,
uint32_t event_len ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes ble_gap_evt_conn_param_update event.

Parameters
[in] p_event Pointer to the ble_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
uint32_t ble_gap_evt_conn_param_update_request_enc ( ble_evt_t const *const p_event ,
uint32_t event_len ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes ble_gap_evt_conn_param_update_request event.

Parameters
[in] p_event Pointer to the ble_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
uint32_t ble_gap_evt_conn_sec_update_enc ( ble_evt_t const *const p_event ,
uint32_t event_len ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes ble_gap_evt_conn_sec_update event.

Parameters
[in] p_event Pointer to the ble_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
uint32_t ble_gap_evt_connected_enc ( ble_evt_t const *const p_event ,
uint32_t event_len ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes ble_gap_evt_connected event.

Parameters
[in] p_event Pointer to the ble_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
uint32_t ble_gap_evt_disconnected_enc ( ble_evt_t const *const p_event ,
uint32_t event_len ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes ble_gap_evt_disconnected event.

Parameters
[in] p_event Pointer to the ble_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
uint32_t ble_gap_evt_key_pressed_enc ( ble_evt_t const *const p_event ,
uint32_t event_len ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes ble_gap_evt_key_pressed event.

Parameters
[in] p_event Pointer to the ble_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
uint32_t ble_gap_evt_lesc_dhkey_request_enc ( ble_evt_t const *const p_event ,
uint32_t event_len ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes ble_gap_evt_lesc_dhkey_request event.

Parameters
[in] p_event Pointer to the ble_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
uint32_t ble_gap_evt_passkey_display_enc ( ble_evt_t const *const p_event ,
uint32_t event_len ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes ble_gap_evt_passkey_display event.

Parameters
[in] p_event Pointer to the ble_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
uint32_t ble_gap_evt_rssi_changed_enc ( ble_evt_t const *const p_event ,
uint32_t event_len ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes ble_gap_evt_rssi_changed event.

Parameters
[in] p_event Pointer to the ble_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
uint32_t ble_gap_evt_scan_req_report_enc ( ble_evt_t const *const p_event ,
uint32_t event_len ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes ble_gap_evt_scan_req_report event.

Parameters
[in] p_event Pointer to the ble_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
uint32_t ble_gap_evt_sec_info_request_enc ( ble_evt_t const *const p_event ,
uint32_t event_len ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes ble_gap_evt_sec_info_request event.

Parameters
[in] p_event Pointer to the ble_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
uint32_t ble_gap_evt_sec_params_request_enc ( ble_evt_t const *const p_event ,
uint32_t event_len ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes ble_gap_evt_sec_params_request event.

Parameters
[in] p_event Pointer to the ble_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
uint32_t ble_gap_evt_sec_request_enc ( ble_evt_t const *const p_event ,
uint32_t event_len ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes ble_gap_evt_sec_request event.

Parameters
[in] p_event Pointer to the ble_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
uint32_t ble_gap_evt_timeout_enc ( ble_evt_t const *const p_event ,
uint32_t event_len ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes ble_gap_evt_timeout event.

Parameters
[in] p_event Pointer to the ble_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.