Adapt a pal::AttClient into a pal::GattClient. More...

#include <AttClientToGattClientAdapter.h>

Public Member Functions
	AttClientToGattClientAdapter (AttClient &client)
	Construct an instance of GattClient from an instance of AttClient.
virtual ble_error_t	exchange_mtu (connection_handle_t connection)
virtual ble_error_t	get_mtu_size (connection_handle_t connection_handle, uint16_t &mtu_size)
virtual ble_error_t	discover_primary_service (connection_handle_t connection, attribute_handle_t discovery_range_begining)
virtual ble_error_t	discover_primary_service_by_service_uuid (connection_handle_t connection_handle, attribute_handle_t discovery_range_begining, const UUID &uuid)
virtual ble_error_t	find_included_service (connection_handle_t connection_handle, attribute_handle_range_t service_range)
virtual ble_error_t	discover_characteristics_of_a_service (connection_handle_t connection_handle, attribute_handle_range_t discovery_range)
virtual ble_error_t	discover_characteristics_descriptors (connection_handle_t connection_handle, attribute_handle_range_t descriptors_discovery_range)
virtual ble_error_t	read_attribute_value (connection_handle_t connection_handle, attribute_handle_t attribute_handle)
virtual ble_error_t	read_using_characteristic_uuid (connection_handle_t connection_handle, attribute_handle_range_t read_range, const UUID &uuid)
virtual ble_error_t	read_attribute_blob (connection_handle_t connection_handle, attribute_handle_t attribute_handle, uint16_t offset)
virtual ble_error_t	read_multiple_characteristic_values (connection_handle_t connection_handle, const ArrayView< const attribute_handle_t > &characteristic_value_handles)
virtual ble_error_t	write_without_response (connection_handle_t connection_handle, attribute_handle_t characteristic_value_handle, const ArrayView< const uint8_t > &value)
virtual ble_error_t	signed_write_without_response (connection_handle_t connection_handle, attribute_handle_t characteristic_value_handle, const ArrayView< const uint8_t > &value)
virtual ble_error_t	write_attribute (connection_handle_t connection_handle, attribute_handle_t attribute_handle, const ArrayView< const uint8_t > &value)
virtual ble_error_t	queue_prepare_write (connection_handle_t connection_handle, attribute_handle_t characteristic_value_handle, const ArrayView< const uint8_t > &value, uint16_t offset)
virtual ble_error_t	execute_write_queue (connection_handle_t connection_handle, bool execute)
virtual ble_error_t	initialize ()
virtual ble_error_t	terminate ()
void	when_server_message_received (mbed::Callback< void(connection_handle_t, const AttServerMessage &)> cb)
	Register a callback which will handle messages from the server.
void	when_transaction_timeout (mbed::Callback< void(connection_handle_t)> cb)
	Register a callback handling transaction timeout.
Protected Member Functions
void	on_server_event (connection_handle_t connection_handle, const AttServerMessage &server_message)
	Upon server message reception an implementation shall call this function.
void	on_transaction_timeout (connection_handle_t connection_handle)
	Upon transaction timeout an implementation shall call this function.

Detailed Description

Adapt a pal::AttClient into a pal::GattClient.

This class let vendors define their abstraction layer in term of an AttClient and adapt any AttClient into a GattClient.

Definition at line 32 of file AttClientToGattClientAdapter.h.

Constructor & Destructor Documentation

AttClientToGattClientAdapter ( AttClient & client )

Construct an instance of GattClient from an instance of AttClient.

Parameters:

client The client to adapt.

Definition at line 44 of file AttClientToGattClientAdapter.h.

Member Function Documentation

virtual ble_error_t discover_characteristics_descriptors	(	connection_handle_t	connection_handle,
		attribute_handle_range_t	descriptors_discovery_range
	)		`[virtual]`

See also:: ble::pal::GattClient::discover_characteristics_descriptors

Implements GattClient.

Definition at line 137 of file AttClientToGattClientAdapter.h.

virtual ble_error_t discover_characteristics_of_a_service	(	connection_handle_t	connection_handle,
		attribute_handle_range_t	discovery_range
	)		`[virtual]`

See also:: ble::pal::GattClient::discover_characteristics_of_a_service

Implements GattClient.

Definition at line 123 of file AttClientToGattClientAdapter.h.

virtual ble_error_t discover_primary_service	(	connection_handle_t	connection,
		attribute_handle_t	discovery_range_begining
	)		`[virtual]`

See also:: ble::pal::GattClient::discover_primary_service

Implements GattClient.

Definition at line 76 of file AttClientToGattClientAdapter.h.

virtual ble_error_t discover_primary_service_by_service_uuid	(	connection_handle_t	connection_handle,
		attribute_handle_t	discovery_range_begining,
		const UUID &	uuid
	)		`[virtual]`

See also:: ble::pal::GattClient::discover_primary_service_by_service_uuid

Implements GattClient.

Definition at line 90 of file AttClientToGattClientAdapter.h.

virtual ble_error_t exchange_mtu ( connection_handle_t connection ) [virtual]

See also:: ble::pal::GattClient::exchange_mtu

Implements GattClient.

Definition at line 59 of file AttClientToGattClientAdapter.h.

virtual ble_error_t execute_write_queue	(	connection_handle_t	connection_handle,
		bool	execute
	)		`[virtual]`

See also:: ble::pal::GattClient::execute_write_queue

Implements GattClient.

Definition at line 268 of file AttClientToGattClientAdapter.h.

virtual ble_error_t find_included_service	(	connection_handle_t	connection_handle,
		attribute_handle_range_t	service_range
	)		`[virtual]`

See also:: ble::pal::GattClient::find_included_service

Implements GattClient.

Definition at line 109 of file AttClientToGattClientAdapter.h.

virtual ble_error_t get_mtu_size	(	connection_handle_t	connection_handle,
		uint16_t &	mtu_size
	)		`[virtual]`

See also:: ble::pal::GattClient::get_mtu_size

Implements GattClient.

Definition at line 66 of file AttClientToGattClientAdapter.h.

virtual ble_error_t initialize ( ) [virtual]

See also:: ble::pal::GattClient::initialize

Implements GattClient.

Definition at line 278 of file AttClientToGattClientAdapter.h.

void on_server_event	(	connection_handle_t	connection_handle,
		const AttServerMessage &	server_message
	)		`[protected, inherited]`

Upon server message reception an implementation shall call this function.

Parameters:

connection_handle	The handle of the connection which has received the server message.
server_message	The message received from the server.

Definition at line 597 of file PalGattClient.h.

void on_transaction_timeout ( connection_handle_t connection_handle ) [protected, inherited]

Upon transaction timeout an implementation shall call this function.

Parameters:

connection_handle The handle of the connection of the transaction which has times out.

Note:: see BLUETOOTH SPECIFICATION Version 5.0 | Vol 3, Part F Section 3.3.3; see BLUETOOTH SPECIFICATION Version 5.0 | Vol 3, Part G Section 4.4.14

Definition at line 615 of file PalGattClient.h.

virtual ble_error_t queue_prepare_write	(	connection_handle_t	connection_handle,
		attribute_handle_t	characteristic_value_handle,
		const ArrayView< const uint8_t > &	value,
		uint16_t	offset
	)		`[virtual]`

See also:: ble::pal::GattClient::queue_prepare_write

Implements GattClient.

Definition at line 251 of file AttClientToGattClientAdapter.h.

virtual ble_error_t read_attribute_blob	(	connection_handle_t	connection_handle,
		attribute_handle_t	attribute_handle,
		uint16_t	offset
	)		`[virtual]`

See also:: ble::pal::GattClient::read_attribute_blob

Implements GattClient.

Definition at line 178 of file AttClientToGattClientAdapter.h.

virtual ble_error_t read_attribute_value	(	connection_handle_t	connection_handle,
		attribute_handle_t	attribute_handle
	)		`[virtual]`

See also:: ble::pal::GattClient::read_attribute_value

Implements GattClient.

Definition at line 150 of file AttClientToGattClientAdapter.h.

virtual ble_error_t read_multiple_characteristic_values	(	connection_handle_t	connection_handle,
		const ArrayView< const attribute_handle_t > &	characteristic_value_handles
	)		`[virtual]`

See also:: ble::pal::GattClient::read_multiple_characteristic_values

Implements GattClient.

Definition at line 193 of file AttClientToGattClientAdapter.h.

virtual ble_error_t read_using_characteristic_uuid	(	connection_handle_t	connection_handle,
		attribute_handle_range_t	read_range,
		const UUID &	uuid
	)		`[virtual]`

See also:: ble::pal::GattClient::read_using_characteristic_uuid

Implements GattClient.

Definition at line 163 of file AttClientToGattClientAdapter.h.

virtual ble_error_t signed_write_without_response	(	connection_handle_t	connection_handle,
		attribute_handle_t	characteristic_value_handle,
		const ArrayView< const uint8_t > &	value
	)		`[virtual]`

See also:: ble::pal::GattClient::signed_write_without_response

Implements GattClient.

Definition at line 221 of file AttClientToGattClientAdapter.h.

virtual ble_error_t terminate ( ) [virtual]

See also:: ble::pal::GattClient::terminate

Implements GattClient.

Definition at line 285 of file AttClientToGattClientAdapter.h.

void when_server_message_received ( mbed::Callback< void(connection_handle_t, const AttServerMessage &)> cb ) [inherited]

Register a callback which will handle messages from the server.

Parameters:

cb	The callback object which will handle messages from the server. It accept two parameters in input: The handle of the connection where the message was received and the message received. Real type of the message can be obtained from its opcode.

Definition at line 562 of file PalGattClient.h.

void when_transaction_timeout ( mbed::Callback< void(connection_handle_t)> cb ) [inherited]

Register a callback handling transaction timeout.

Parameters:

cb	The callback handling timeout of a transaction. It accepts as a parameter the connection handle involved in the timeout.

Note:: No more attribute protocol requests, commands, indication or notification shall be sent over a connection implied in a transaction timeout. To send a new ATT message, the conenction should be reestablished.

Definition at line 579 of file PalGattClient.h.

virtual ble_error_t write_attribute	(	connection_handle_t	connection_handle,
		attribute_handle_t	attribute_handle,
		const ArrayView< const uint8_t > &	value
	)		`[virtual]`

See also:: ble::pal::GattClient::write_attribute

Implements GattClient.

Definition at line 236 of file AttClientToGattClientAdapter.h.

virtual ble_error_t write_without_response	(	connection_handle_t	connection_handle,
		attribute_handle_t	characteristic_value_handle,
		const ArrayView< const uint8_t > &	value
	)		`[virtual]`

See also:: ble::pal::GattClient::write_without_response

Implements GattClient.

Definition at line 206 of file AttClientToGattClientAdapter.h.

Type:	Program
Mbed OS support:	Mbed OS
Created:	23 Feb 2019
Imports:	43
Forks:	0
Commits:	1
Dependents:	0
Dependencies:	0
Followers:	1

AttClientToGattClientAdapter Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

AttClientToGattClientAdapter Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning