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

#include <GattCallbackParamTypes.h>

Data Fields

Gap::Handle_t connHandle
 
GattAttribute::Handle_t handle
 
uint16_t offset
 
union {
   uint16_t   len
 
   uint8_t   error_code
 
}; 
 
const uint8_t * data
 
ble_error_t status
 

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.

Field Documentation

Gap::Handle_t GattReadCallbackParams::connHandle

Handle of the connection that triggered the event.

const uint8_t* GattReadCallbackParams::data

Pointer to the data read.

Attention
Data may not persist beyond the callback scope.
uint8_t GattReadCallbackParams::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.
GattAttribute::Handle_t GattReadCallbackParams::handle

Attribute Handle to which the read operation applies.

uint16_t GattReadCallbackParams::len

Length in bytes of the data read.

uint16_t GattReadCallbackParams::offset

Offset within the attribute value read.

ble_error_t GattReadCallbackParams::status

Status of the GattClient Read operation.

Attention
Reserved for GattClient registered callbacks.

The documentation for this struct was generated from the following file:
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.