nRF5 SDK v17.1.0
Functions
GATTC connectivity command request decoders and command response encoders

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_bufPointer to beginning of command request packet.
[in]buf_lenLength (in bytes) of request packet.
[out]p_conn_handlePointer to connection handle of the connection.
[out]pp_handle_rangePointer to pointer to the range of handles.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding 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_codeReturn code indicating if command was successful or not.
[in]p_bufPointer to buffer where encoded data command response will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command response packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding 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_bufPointer to beginning of command request packet.
[in]packet_lenLength (in bytes) of request packet.
[out]p_conn_handlePointer to connection handle of the connection.
[out]pp_uuidPointer to pointer to a characteristic value UUID to read.
[out]pp_handle_rangePointer to pointer to the range of handles to perform this procedure on.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding 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_codeReturn code indicating if command was successful or not.
[in]p_bufPointer to buffer where encoded data command response will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command response packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding 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_bufPointer to beginning of command response packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_conn_handlePointer to connection handle.
[out]pp_handlesPointer to pointer to handle table.
[out]p_handle_countPointer to handle handle table count.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHDecoding 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_codeReturn code indicating if command was successful or not.
[in]p_bufPointer to buffer where encoded data command response will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command response packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding 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_bufPointer to beginning of command request packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_conn_handlePointer to connection handle.
[out]pp_handle_rangePointer to pointer to handle range.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding 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_codeReturn code indicating if command was successful or not.
[in]p_bufPointer to buffer where encoded data command response will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command response packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding 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_bufPointer to beginning of command request packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_conn_handlePointer to connection handle.
[out]pp_handle_rangePointer to pointer to handle range.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding 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_codeReturn code indicating if command was successful or not.
[in]p_bufPointer to buffer where encoded data command response will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command response packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding 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_bufPointer to beginning of command request packet.
[in]packet_lenLength (in bytes) of request packet.
[out]p_conn_handlePointer to connection handle of the connection.
[out]p_client_rx_mtuPointer to Client RX MTU size.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding 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_codeReturn code indicating if command was successful or not.
[in]p_bufPointer to buffer where encoded data command response will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command response packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding 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_bufPointer to beginning of command response packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_conn_handlePointer to connection handle.
[out]p_handlePointer to handle of the attribute in the indication.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHDecoding 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_codeReturn code indicating if command was successful or not.
[in]p_bufPointer to buffer where encoded data command response will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command response packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding 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_bufPointer to beginning of command request packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_conn_handlePointer to connection handle.
[out]p_start_handlePointer to start handle.
[out]pp_srvc_uuidPointer to pointer to service uuid.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding 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_codeReturn code indicating if command was successful or not.
[in]p_bufPointer to buffer where encoded data command response will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command response packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding 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_bufPointer to beginning of command response packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_conn_handlePointer to connection handle.
[out]p_handlePointer to handle.
[out]p_offsetPointer to offset.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHDecoding 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_codeReturn code indicating if command was successful or not.
[in]p_bufPointer to buffer where encoded data command response will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command response packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding 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_bufPointer to beginning of command request packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_conn_handlePointer to connection handle.
[out]pp_handle_rangePointer to pointer to handle range.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding 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_codeReturn code indicating if command was successful or not.
[in]p_bufPointer to buffer where encoded data command response will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command response packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding 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_bufPointer to beginning of command response packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_conn_handlePointer to connection handle.
[out]pp_write_paramsPointer to pointer to write parameters.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHDecoding 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_codeReturn code indicating if command was successful or not.
[in]p_bufPointer to buffer where encoded data command response will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command response packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding failure. Incorrect buffer length.

Documentation feedback | Developer Zone | Subscribe | Updated