GATTC connectivity command request decoders and command response encoders

nRF5 SDK v12.2.0
Functions

GATTC Connectivity command request decoders and command response encoders. More...

Functions

uint32_t ble_gattc_characteristics_discover_req_dec (uint8_t const *const p_buf, uint16_t packet_len, uint16_t *const p_conn_handle, ble_gattc_handle_range_t **const pp_handle_range)
Decodes sd_ble_gattc_characteristics_discover command request. More...
uint32_t ble_gattc_characteristics_discover_rsp_enc (uint32_t return_code, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes sd_ble_gattc_characteristics_discover command response. More...
uint32_t ble_gattc_descriptors_discover_req_dec (uint8_t const *const p_buf, uint16_t packet_len, uint16_t *const p_conn_handle, ble_gattc_handle_range_t **const pp_handle_range)
Decodes sd_ble_gattc_descriptors_discover command request. More...
uint32_t ble_gattc_descriptors_discover_rsp_enc (uint32_t return_code, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes sd_ble_gattc_descriptors_discover command response. More...
uint32_t ble_gattc_relationships_discover_req_dec (uint8_t const *const p_buf, uint16_t packet_len, uint16_t *const p_conn_handle, ble_gattc_handle_range_t **const pp_handle_range)
Decodes sd_ble_gattc_relationships_discover command request. More...
uint32_t ble_gattc_relationships_discover_rsp_enc (uint32_t return_code, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes sd_ble_gattc_relationships_discover command response. More...
uint32_t ble_gattc_primary_services_discover_req_dec (uint8_t const *const p_buf, uint16_t packet_len, uint16_t *const p_conn_handle, uint16_t *const p_start_handle, ble_uuid_t **const pp_srvc_uuid)
Decodes sd_ble_gattc_primary_services_discover command request. More...
uint32_t ble_gattc_primary_services_discover_rsp_enc (uint32_t return_code, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes sd_ble_gattc_primary_services_discover command response. More...
uint32_t ble_gattc_read_req_dec (uint8_t const *const p_buf, uint16_t packet_len, uint16_t *const p_conn_handle, uint16_t *const p_handle, uint16_t *const p_offset)
Decodes sd_ble_gattc_read command request. More...
uint32_t ble_gattc_read_rsp_enc (uint32_t return_code, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes sd_ble_gattc_read command response. More...
uint32_t ble_gattc_char_values_read_req_dec (uint8_t const *const p_buf, uint16_t packet_len, uint16_t *const p_conn_handle, uint16_t **const pp_handles, uint16_t *const p_handle_count)
Decodes sd_ble_gattc_char_values_read command request. More...
uint32_t ble_gattc_char_values_read_rsp_enc (uint32_t return_code, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes sd_ble_gattc_char_values_read command response. More...
uint32_t ble_gattc_write_req_dec (uint8_t const *const p_buf, uint16_t packet_len, uint16_t *const p_conn_handle, ble_gattc_write_params_t **const pp_write_params)
Decodes sd_ble_gattc_write command request. More...
uint32_t ble_gattc_write_rsp_enc (uint32_t return_code, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes sd_ble_gattc_write command response. More...
uint32_t ble_gattc_hv_confirm_req_dec (uint8_t const *const p_buf, uint32_t packet_len, uint16_t *const p_conn_handle, uint16_t *const p_handle)
Decodes sd_ble_gattc_hv_confirm command request. More...
uint32_t ble_gattc_hv_confirm_rsp_enc (uint32_t return_code, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes sd_ble_gattc_hv_confirm command response. More...
uint32_t ble_gattc_char_value_by_uuid_read_req_dec (uint8_t const *const p_buf, uint16_t packet_len, uint16_t *const p_conn_handle, ble_uuid_t **const pp_uuid, ble_gattc_handle_range_t **const pp_handle_range)
Decodes sd_ble_gattc_char_value_by_uuid_read command request. More...
uint32_t ble_gattc_char_value_by_uuid_read_rsp_enc (uint32_t return_code, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes sd_ble_gattc_char_value_by_uuid_read command response. More...
uint32_t ble_gattc_attr_info_discover_req_dec (uint8_t const *const p_buf, uint16_t buf_len, uint16_t *const p_conn_handle, ble_gattc_handle_range_t **const pp_handle_range)
Decodes sd_ble_gattc_attr_info_discover command request. More...
uint32_t ble_gattc_attr_info_discover_rsp_enc (uint32_t return_code, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes sd_ble_gattc_attr_info_discover command response. More...
uint32_t ble_gattc_exchange_mtu_request_req_dec (uint8_t const *const p_buf, uint16_t packet_len, uint16_t *const p_conn_handle, uint16_t *const p_client_rx_mtu)
Decodes sd_ble_gattc_exchange_mtu_request command request. More...
uint32_t ble_gattc_exchange_mtu_request_rsp_enc (uint32_t return_code, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes sd_ble_gattc_exchange_mtu_request command response. More...

Detailed Description

GATTC Connectivity command request decoders and command response encoders.

Function Documentation

uint32_t ble_gattc_attr_info_discover_req_dec ( uint8_t const *const p_buf ,
uint16_t buf_len ,
uint16_t *const p_conn_handle ,
ble_gattc_handle_range_t **const pp_handle_range
)

Decodes sd_ble_gattc_attr_info_discover command request.

See Also
ble_gattc_attr_info_discover_rsp_enc for response encoding.
Parameters
[in] p_buf Pointer to beginning of command request packet.
[in] buf_len Length (in bytes) of request packet.
[out] p_conn_handle Pointer to connection handle of the connection.
[out] pp_handle_range Pointer to pointer to the range of handles.
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_INVALID_DATA Decoding failure. Invalid operation type.
uint32_t ble_gattc_attr_info_discover_rsp_enc ( uint32_t return_code ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes sd_ble_gattc_attr_info_discover command response.

See Also
ble_gattc_attr_info_discover_req_dec for request decoding.
Parameters
[in] return_code Return code indicating if command was successful or not.
[in] p_buf Pointer to buffer where encoded data command response will be returned.
[in,out] p_buf_len in: size of p_buf buffer. out: Length of encoded command response packet.
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_gattc_char_value_by_uuid_read_req_dec ( uint8_t const *const p_buf ,
uint16_t packet_len ,
uint16_t *const p_conn_handle ,
ble_uuid_t **const pp_uuid ,
ble_gattc_handle_range_t **const pp_handle_range
)

Decodes sd_ble_gattc_char_value_by_uuid_read command request.

See Also
ble_gattc_char_value_by_uuid_read_rsp_enc for response encoding.
Parameters
[in] p_buf Pointer to beginning of command request packet.
[in] packet_len Length (in bytes) of request packet.
[out] p_conn_handle Pointer to connection handle of the connection.
[out] pp_uuid Pointer to pointer to a characteristic value UUID to read.
[out] pp_handle_range Pointer to pointer to the range of handles to perform this procedure on.
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_INVALID_DATA Decoding failure. Invalid operation type.
uint32_t ble_gattc_char_value_by_uuid_read_rsp_enc ( uint32_t return_code ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes sd_ble_gattc_char_value_by_uuid_read command response.

See Also
ble_gattc_char_value_by_uuid_read_req_dec for request decoding.
Parameters
[in] return_code Return code indicating if command was successful or not.
[in] p_buf Pointer to buffer where encoded data command response will be returned.
[in,out] p_buf_len in: size of p_buf buffer. out: Length of encoded command response packet.
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_gattc_char_values_read_req_dec ( uint8_t const *const p_buf ,
uint16_t packet_len ,
uint16_t *const p_conn_handle ,
uint16_t **const pp_handles ,
uint16_t *const p_handle_count
)

Decodes sd_ble_gattc_char_values_read command request.

See Also
ble_gattc_char_values_read_rsp_enc for response encoding.
Parameters
[in] p_buf Pointer to beginning of command response packet.
[in] packet_len Length (in bytes) of response packet.
[out] p_conn_handle Pointer to connection handle.
[out] pp_handles Pointer to pointer to handle table.
[out] p_handle_count Pointer to handle handle table count.
Return values
NRF_SUCCESS Decoding success.
NRF_ERROR_NULL Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
uint32_t ble_gattc_char_values_read_rsp_enc ( uint32_t return_code ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes sd_ble_gattc_char_values_read command response.

See Also
ble_gattc_char_values_read_req_dec for request decoding.
Parameters
[in] return_code Return code indicating if command was successful or not.
[in] p_buf Pointer to buffer where encoded data command response will be returned.
[in,out] p_buf_len in: size of p_buf buffer. out: Length of encoded command response packet.
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_gattc_characteristics_discover_req_dec ( uint8_t const *const p_buf ,
uint16_t packet_len ,
uint16_t *const p_conn_handle ,
ble_gattc_handle_range_t **const pp_handle_range
)

Decodes sd_ble_gattc_characteristics_discover command request.

See Also
ble_gattc_characteristics_discover_rsp_enc for response encoding.
Parameters
[in] p_buf Pointer to beginning of command request packet.
[in] packet_len Length (in bytes) of response packet.
[out] p_conn_handle Pointer to connection handle.
[out] pp_handle_range Pointer to pointer to handle range.
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_INVALID_DATA Decoding failure. Invalid value for handle range field present.
uint32_t ble_gattc_characteristics_discover_rsp_enc ( uint32_t return_code ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes sd_ble_gattc_characteristics_discover command response.

See Also
ble_gattc_characteristics_discover_req_dec for request decoding.
Parameters
[in] return_code Return code indicating if command was successful or not.
[in] p_buf Pointer to buffer where encoded data command response will be returned.
[in,out] p_buf_len in: size of p_buf buffer. out: Length of encoded command response packet.
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_gattc_descriptors_discover_req_dec ( uint8_t const *const p_buf ,
uint16_t packet_len ,
uint16_t *const p_conn_handle ,
ble_gattc_handle_range_t **const pp_handle_range
)

Decodes sd_ble_gattc_descriptors_discover command request.

See Also
ble_gattc_descriptors_discover_rsp_enc for response encoding.
Parameters
[in] p_buf Pointer to beginning of command request packet.
[in] packet_len Length (in bytes) of response packet.
[out] p_conn_handle Pointer to connection handle.
[out] pp_handle_range Pointer to pointer to handle range.
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_INVALID_DATA Decoding failure. Invalid value for handle range field present.
uint32_t ble_gattc_descriptors_discover_rsp_enc ( uint32_t return_code ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes sd_ble_gattc_descriptors_discover command response.

See Also
ble_gattc_descriptors_discover_req_dec for request decoding.
Parameters
[in] return_code Return code indicating if command was successful or not.
[in] p_buf Pointer to buffer where encoded data command response will be returned.
[in,out] p_buf_len in: size of p_buf buffer. out: Length of encoded command response packet.
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_gattc_exchange_mtu_request_req_dec ( uint8_t const *const p_buf ,
uint16_t packet_len ,
uint16_t *const p_conn_handle ,
uint16_t *const p_client_rx_mtu
)

Decodes sd_ble_gattc_exchange_mtu_request command request.

See Also
ble_gattc_exchange_mtu_request_rsp_enc for response encoding.
Parameters
[in] p_buf Pointer to beginning of command request packet.
[in] packet_len Length (in bytes) of request packet.
[out] p_conn_handle Pointer to connection handle of the connection.
[out] p_client_rx_mtu Pointer to Client RX MTU size.
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_INVALID_DATA Decoding failure. Invalid operation type.
uint32_t ble_gattc_exchange_mtu_request_rsp_enc ( uint32_t return_code ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes sd_ble_gattc_exchange_mtu_request command response.

See Also
ble_gattc_exchange_mtu_request_req_dec for request decoding.
Parameters
[in] return_code Return code indicating if command was successful or not.
[in] p_buf Pointer to buffer where encoded data command response will be returned.
[in,out] p_buf_len in: size of p_buf buffer. out: Length of encoded command response packet.
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_gattc_hv_confirm_req_dec ( uint8_t const *const p_buf ,
uint32_t packet_len ,
uint16_t *const p_conn_handle ,
uint16_t *const p_handle
)

Decodes sd_ble_gattc_hv_confirm command request.

See Also
ble_gattc_hv_confirm_rsp_enc for response encoding.
Parameters
[in] p_buf Pointer to beginning of command response packet.
[in] packet_len Length (in bytes) of response packet.
[out] p_conn_handle Pointer to connection handle.
[out] p_handle Pointer to handle of the attribute in the indication.
Return values
NRF_SUCCESS Decoding success.
NRF_ERROR_NULL Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
uint32_t ble_gattc_hv_confirm_rsp_enc ( uint32_t return_code ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes sd_ble_gattc_hv_confirm command response.

See Also
ble_gattc_hv_confirm_req_dec for request decoding.
Parameters
[in] return_code Return code indicating if command was successful or not.
[in] p_buf Pointer to buffer where encoded data command response will be returned.
[in,out] p_buf_len in: size of p_buf buffer. out: Length of encoded command response packet.
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_gattc_primary_services_discover_req_dec ( uint8_t const *const p_buf ,
uint16_t packet_len ,
uint16_t *const p_conn_handle ,
uint16_t *const p_start_handle ,
ble_uuid_t **const pp_srvc_uuid
)

Decodes sd_ble_gattc_primary_services_discover command request.

See Also
ble_gattc_primary_services_discover_rsp_enc for response encoding.
Parameters
[in] p_buf Pointer to beginning of command request packet.
[in] packet_len Length (in bytes) of response packet.
[out] p_conn_handle Pointer to connection handle.
[out] p_start_handle Pointer to start handle.
[out] pp_srvc_uuid Pointer to pointer to service uuid.
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_INVALID_DATA Decoding failure. Invalid value for uuid field present.
uint32_t ble_gattc_primary_services_discover_rsp_enc ( uint32_t return_code ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes sd_ble_gattc_primary_services_discover command response.

See Also
ble_gattc_primary_services_discover_req_dec for request decoding.
Parameters
[in] return_code Return code indicating if command was successful or not.
[in] p_buf Pointer to buffer where encoded data command response will be returned.
[in,out] p_buf_len in: size of p_buf buffer. out: Length of encoded command response packet.
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_gattc_read_req_dec ( uint8_t const *const p_buf ,
uint16_t packet_len ,
uint16_t *const p_conn_handle ,
uint16_t *const p_handle ,
uint16_t *const p_offset
)

Decodes sd_ble_gattc_read command request.

See Also
ble_gattc_read_rsp_enc for response encoding.
Parameters
[in] p_buf Pointer to beginning of command response packet.
[in] packet_len Length (in bytes) of response packet.
[out] p_conn_handle Pointer to connection handle.
[out] p_handle Pointer to handle.
[out] p_offset Pointer to offset.
Return values
NRF_SUCCESS Decoding success.
NRF_ERROR_NULL Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
uint32_t ble_gattc_read_rsp_enc ( uint32_t return_code ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes sd_ble_gattc_read command response.

See Also
ble_gattc_read_req_dec for request decoding.
Parameters
[in] return_code Return code indicating if command was successful or not.
[in] p_buf Pointer to buffer where encoded data command response will be returned.
[in,out] p_buf_len in: size of p_buf buffer. out: Length of encoded command response packet.
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_gattc_relationships_discover_req_dec ( uint8_t const *const p_buf ,
uint16_t packet_len ,
uint16_t *const p_conn_handle ,
ble_gattc_handle_range_t **const pp_handle_range
)

Decodes sd_ble_gattc_relationships_discover command request.

See Also
ble_gattc_relationships_discover_rsp_enc for response encoding.
Parameters
[in] p_buf Pointer to beginning of command request packet.
[in] packet_len Length (in bytes) of response packet.
[out] p_conn_handle Pointer to connection handle.
[out] pp_handle_range Pointer to pointer to handle range.
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_INVALID_DATA Decoding failure. Invalid value for handle range field present.
uint32_t ble_gattc_relationships_discover_rsp_enc ( uint32_t return_code ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes sd_ble_gattc_relationships_discover command response.

See Also
ble_gattc_relationships_discover_req_dec for request decoding.
Parameters
[in] return_code Return code indicating if command was successful or not.
[in] p_buf Pointer to buffer where encoded data command response will be returned.
[in,out] p_buf_len in: size of p_buf buffer. out: Length of encoded command response packet.
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_gattc_write_req_dec ( uint8_t const *const p_buf ,
uint16_t packet_len ,
uint16_t *const p_conn_handle ,
ble_gattc_write_params_t **const pp_write_params
)

Decodes sd_ble_gattc_write command request.

See Also
ble_gattc_write_rsp_enc for response encoding.
Parameters
[in] p_buf Pointer to beginning of command response packet.
[in] packet_len Length (in bytes) of response packet.
[out] p_conn_handle Pointer to connection handle.
[out] pp_write_params Pointer to pointer to write parameters.
Return values
NRF_SUCCESS Decoding success.
NRF_ERROR_NULL Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
uint32_t ble_gattc_write_rsp_enc ( uint32_t return_code ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes sd_ble_gattc_write command response.

See Also
ble_gattc_write_req_dec for request decoding.
Parameters
[in] return_code Return code indicating if command was successful or not.
[in] p_buf Pointer to buffer where encoded data command response will be returned.
[in,out] p_buf_len in: size of p_buf buffer. out: Length of encoded command response packet.
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.