BT-GATT Client Callbacks

Callbacks for BT-GATT Client Interface. More...

Typedefs
typedef void(*	BTRegisterClientCallback_t) (BTGattStatus_t xStatus, uint8_t ucClientIf, BTUuid_t *pxAppUuid)
	Callback invoked in response pxRegisterClient when the GATT client registration has been completed.
typedef void(*	BTSearchCompleteCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus)
	Callback invoked in response to pxSearchService when the GATT service search has been completed.
typedef void(*	BTRegisterForNotificationCallback_t) (uint16_t usConnId, bool bRegistered, BTGattStatus_t xStatus, uint16_t usHandle)
	Callback invoked in response to pxRegisterForNotification and pxUnregisterForNotification.
typedef void(*	BTNotifyCallback_t) (uint16_t usConnId, BTGattNotifyParams_t *pxData)
	Remote device notification callback, invoked when a remote device sends a notification or indication that a client has registered for.
typedef void(*	BTReadCharacteristicCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, BTGattReadParams_t *pxData)
	Reports result of a GATT read operation. Triggered by pxReadCharacteristic.
typedef void(*	BTWriteCharacteristicCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, uint16_t usHandle)
	GATT write characteristic operation callback. Triggered by pxWriteCharacteristic.
typedef void(*	BTExecuteWriteCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus)
	GATT execute prepared write callback. Triggered by pxExecuteWrite.
typedef void(*	BTReadDescriptorCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, BTGattReadParams_t *pxData)
	Callback invoked in response to pxReadDescriptor.
typedef void(*	BTWriteDescriptorCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, uint16_t usHandle)
	Callback invoked in response to pxWriteDescriptor.
typedef void(*	BTListenCallback_t) (BTGattStatus_t xStatus, uint32_t ulServerIf)
	Callback indicating the status of a listen() operation.
typedef void(*	BTConfigureMtuCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, uint32_t ulMtu)
	Callback invoked when the MTU for a given connection changes. Triggered by pxConfigureMtu.
typedef void(*	BTGetGattDbCallback_t) (uint16_t usConnId, BTGattDbElement_t *pxDb, uint32_t ulCount)
	GATT get database callback. Triggered by pxGetGattDb.
typedef void(*	BTServicesRemovedCallback_t) (uint16_t usConnId, uint16_t usStartHandle, uint16_t usEndHandle)
	GATT services between startHandle and endHandle were removed.
typedef void(*	BTServicesAddedCallback_t) (uint16_t usConnId, BTGattDbElement_t *pxAdded, uint32_t ulAddedCount)
	GATT services were added.

Detailed Description

Callbacks for BT-GATT Client Interface.

Typedef Documentation

BTRegisterClientCallback_t

typedef void(* BTRegisterClientCallback_t) (BTGattStatus_t xStatus, uint8_t ucClientIf, BTUuid_t *pxAppUuid)

Callback invoked in response pxRegisterClient when the GATT client registration has been completed.

BT-GATT Client callback structure.

Parameters

[in]	xStatus	returns eBTStatusSuccess if operation succeeded.
[in]	ucClientIf	Client interface.
[in]	pxAppUuid	GATT client UUID.

BTSearchCompleteCallback_t

typedef void(* BTSearchCompleteCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus)

Callback invoked in response to pxSearchService when the GATT service search has been completed.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	xStatus	returns eBTGattStatusSuccess if operation succeeded.

BTRegisterForNotificationCallback_t

typedef void(* BTRegisterForNotificationCallback_t) (uint16_t usConnId, bool bRegistered, BTGattStatus_t xStatus, uint16_t usHandle)

Callback invoked in response to pxRegisterForNotification and pxUnregisterForNotification.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	bRegistered	Set to True if attribute id registered for notifications, set to False otherwise.
[in]	xStatus	returns eBTGattStatusSuccess if operation succeeded.
[in]	usHandle	Handle number of attribute [de]registered for notification.

BTNotifyCallback_t

typedef void(* BTNotifyCallback_t) (uint16_t usConnId, BTGattNotifyParams_t *pxData)

Remote device notification callback, invoked when a remote device sends a notification or indication that a client has registered for.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	pxData	Parameters for attribute change notifications.

BTReadCharacteristicCallback_t

typedef void(* BTReadCharacteristicCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, BTGattReadParams_t *pxData)

Reports result of a GATT read operation. Triggered by pxReadCharacteristic.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	xStatus	returns eBTGattStatusSuccess if operation succeeded.
[in]	pxData	Parameters for GATT read operation.

BTWriteCharacteristicCallback_t

typedef void(* BTWriteCharacteristicCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, uint16_t usHandle)

GATT write characteristic operation callback. Triggered by pxWriteCharacteristic.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	xStatus	returns eBTGattStatusSuccess if operation succeeded.
[in]	usHandle	Handle of the attribute written to.

BTExecuteWriteCallback_t

typedef void(* BTExecuteWriteCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus)

GATT execute prepared write callback. Triggered by pxExecuteWrite.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	xStatus	returns eBTGattStatusSuccess if operation succeeded.

BTReadDescriptorCallback_t

typedef void(* BTReadDescriptorCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, BTGattReadParams_t *pxData)

Callback invoked in response to pxReadDescriptor.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	xStatus	returns eBTGattStatusSuccess if operation succeeded.
[in]	pxData	Parameters for GATT read operation.

BTWriteDescriptorCallback_t

typedef void(* BTWriteDescriptorCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, uint16_t usHandle)

Callback invoked in response to pxWriteDescriptor.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	xStatus	returns eBTGattStatusSuccess if operation succeeded.
[in]	usHandle	Handle of the attribute written to.

BTListenCallback_t

typedef void(* BTListenCallback_t) (BTGattStatus_t xStatus, uint32_t ulServerIf)

Callback indicating the status of a listen() operation.

Callback has been deprecated, use BTAdvStatusCallback_t in BTBleAdapterCallbacks_t instead.

BTConfigureMtuCallback_t

typedef void(* BTConfigureMtuCallback_t) (uint16_t usConnId, BTGattStatus_t xStatus, uint32_t ulMtu)

Callback invoked when the MTU for a given connection changes. Triggered by pxConfigureMtu.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	xStatus	returns eBTGattStatusSuccess if operation succeeded.
[in]	ulMtu	MTU size.

BTGetGattDbCallback_t

typedef void(* BTGetGattDbCallback_t) (uint16_t usConnId, BTGattDbElement_t *pxDb, uint32_t ulCount)

GATT get database callback. Triggered by pxGetGattDb.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	pxDb	GATT database elements
[in]	ulCount	Number of elements in GATT database.

BTServicesRemovedCallback_t

typedef void(* BTServicesRemovedCallback_t) (uint16_t usConnId, uint16_t usStartHandle, uint16_t usEndHandle)

GATT services between startHandle and endHandle were removed.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	usStartHandle	First service handle removed from server.
[in]	usEndHandle	Last service handle removed from server.

BTServicesAddedCallback_t

typedef void(* BTServicesAddedCallback_t) (uint16_t usConnId, BTGattDbElement_t *pxAdded, uint32_t ulAddedCount)

GATT services were added.

Parameters

[in]	usConnId	Connection Identifier, created and returned on connection event, when BTConnectionCallback_t is invoked.
[in]	pxAdded	GATT database elements added.
[in]	ulAddedCount	Number of GATT database elements added.