Mistake on this page?
Report an issue in GitHub or email us
Public Types | Data Fields
GattWriteCallbackParams Struct Reference

GATT Write event definition. More...

#include <GattCallbackParamTypes.h>

Public Types

Data Fields

ble::connection_handle_t connHandle
 Handle of the connection that triggered the event. More...
 
GattAttribute::Handle_t handle
 Handle of the attribute to which the write operation applies. More...
 
WriteOp_t writeOp
 Type of the write operation. More...
 
const uint8_t * data
 Pointer to the data to write. More...
 
uint16_t offset
 Offset within the attribute value to be written. More...
 
ble_error_t status
 Status of the GattClient Write operation. More...
 
uint16_t len
 Length (in bytes) of the data to write. More...
 
uint8_t error_code
 Error code of the GattClient Write operation. More...
 

Detailed Description

GATT Write event definition.

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

Attention
The GattServer only populates the fields offset, len and data when it has received a write request. Callbacks attached to the GattClient do not use those fields.
The GattClient only populates the fields status and error_code when it has received a write response. Callbacks attached to the GattServer do not use those fields.

Definition at line 45 of file GattCallbackParamTypes.h.

Member Enumeration Documentation

enum WriteOp_t

Enumeration of allowed write operations.

Enumerator
OP_INVALID 

Invalid operation.

OP_WRITE_REQ 

Write request.

OP_WRITE_CMD 

Write command.

OP_SIGN_WRITE_CMD 

Signed write command.

OP_PREP_WRITE_REQ 

Prepare write request.

OP_EXEC_WRITE_REQ_CANCEL 

Execute write request: cancel all prepared writes.

OP_EXEC_WRITE_REQ_NOW 

Execute write request: immediately execute all prepared writes.

Definition at line 49 of file GattCallbackParamTypes.h.

Field Documentation

Handle of the connection that triggered the event.

Definition at line 89 of file GattCallbackParamTypes.h.

const uint8_t* data

Pointer to the data to write.

Attention
Data may not persist beyond the callback scope.
Reserved for GattServer registered callbacks.

Definition at line 140 of file GattCallbackParamTypes.h.

uint8_t error_code

Error code of the GattClient Write operation.

Attention
Reserved for GattClient registered callbacks.

Definition at line 130 of file GattCallbackParamTypes.h.

Handle of the attribute to which the write operation applies.

Definition at line 94 of file GattCallbackParamTypes.h.

uint16_t len

Length (in bytes) of the data to write.

Attention
Reserved for GattServer registered callbacks.

Definition at line 123 of file GattCallbackParamTypes.h.

uint16_t offset

Offset within the attribute value to be written.

Attention
Reserved for GattServer registered callbacks.

Definition at line 107 of file GattCallbackParamTypes.h.

ble_error_t status

Status of the GattClient Write operation.

Attention
Reserved for GattClient registered callbacks.

Definition at line 114 of file GattCallbackParamTypes.h.

WriteOp_t writeOp

Type of the write operation.

Definition at line 99 of file 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.