Mbed OS Reference
Loading...
Searching...
No Matches
GattWriteCallbackParams Struct Reference

GATT Write event definition. More...

#include <GattCallbackParamTypes.h>

Public Types

enum  WriteOp_t {
  OP_INVALID = 0x00 , OP_WRITE_REQ = 0x01 , OP_WRITE_CMD = 0x02 , OP_SIGN_WRITE_CMD = 0x03 ,
  OP_PREP_WRITE_REQ = 0x04 , OP_EXEC_WRITE_REQ_CANCEL = 0x05 , OP_EXEC_WRITE_REQ_NOW = 0x06
}
 Enumeration of allowed write operations. More...
 

Data Fields

ble::connection_handle_t connHandle
 Handle of the connection that triggered the event.
 
GattAttribute::Handle_t handle
 Handle of the attribute to which the write operation applies.
 
WriteOp_t writeOp
 Type of the write operation.
 
const uint8_t * data
 Pointer to the data to write.
 

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 gatt/GattCallbackParamTypes.h.

Member Enumeration Documentation

◆ WriteOp_t

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 gatt/GattCallbackParamTypes.h.

Field Documentation

◆ connHandle

Handle of the connection that triggered the event.

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

◆ handle

Handle of the attribute to which the write operation applies.

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

◆ writeOp

WriteOp_t writeOp

Type of the write operation.

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

◆ offset

uint16_t offset

Offset within the attribute value to be written.

Attention
Reserved for GattServer registered callbacks.

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

◆ status

ble_error_t status

Status of the GattClient Write operation.

Attention
Reserved for GattClient registered callbacks.

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

◆ len

uint16_t len

Length (in bytes) of the data to write.

Attention
Reserved for GattServer registered callbacks.

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

◆ error_code

uint8_t error_code

Error code of the GattClient Write operation.

Attention
Reserved for GattClient registered callbacks.

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

◆ data

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 gatt/GattCallbackParamTypes.h.