Mistake on this page?
Report an issue in GitHub or email us
Data Fields
GattReadCallbackParams Struct Reference

GATT Read event definition. More...

#include <GattCallbackParamTypes.h>

Data Fields

ble::connection_handle_t connHandle
 Handle of the connection that triggered the event. More...
 
GattAttribute::Handle_t handle
 Attribute Handle to which the read operation applies. More...
 
uint16_t offset
 Offset within the attribute value read. More...
 
const uint8_t * data
 Pointer to the data read. More...
 
ble_error_t status
 Status of the GattClient Read operation. More...
 
uint16_t len
 Length in bytes of the data read. More...
 
uint8_t error_code
 Error code of the GattClient read operation. More...
 

Detailed Description

GATT Read event definition.

Instances of this type are created and passed to user registered callbacks whether the GattServer has received a read request or a GattClient has received a read response.

Attention
The GattClient only populates the fields status and error_code when it has received a read response. Callbacks attached to the GattServer do not use those fields.

Definition at line 154 of file gatt/GattCallbackParamTypes.h.

Field Documentation

Handle of the connection that triggered the event.

Definition at line 158 of file gatt/GattCallbackParamTypes.h.

const uint8_t* data

Pointer to the data read.

Attention
Data may not persist beyond the callback scope.

Definition at line 192 of file gatt/GattCallbackParamTypes.h.

uint8_t error_code

Error code of the GattClient read operation.

Attention
Reserved for GattClient registered callbacks.
set if status is not equal to BLE_ERROR_NONE; otherwise, this field is interpreted as len.

Definition at line 184 of file gatt/GattCallbackParamTypes.h.

Attribute Handle to which the read operation applies.

Definition at line 163 of file gatt/GattCallbackParamTypes.h.

uint16_t len

Length in bytes of the data read.

Definition at line 174 of file gatt/GattCallbackParamTypes.h.

uint16_t offset

Offset within the attribute value read.

Definition at line 168 of file gatt/GattCallbackParamTypes.h.

ble_error_t status

Status of the GattClient Read operation.

Attention
Reserved for GattClient registered callbacks.

Definition at line 199 of file gatt/GattCallbackParamTypes.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.