IOT-ESP32
Public Member Functions
SecureClient Class Reference

Public Member Functions

uint8_t close ()
 Close the BLE client connection. More...
 
uint8_t configure ()
 Configure the device using BLE GATT. More...
 
uint8_t connect ()
 Initiate a connection with device. More...
 
uint8_t give ()
 Give back connection semaphore. More...
 
uint8_t take ()
 Take connection semaphore. More...
 

Detailed Description

@class SecureClient
@brief Handling of a BLE connection

This class represents and provides everything regarding

J the BLE connection lifecycle of a defined device.

Member Function Documentation

◆ take()

uint8_t SecureClient::take ( )

Take connection semaphore.

Exclusively operate on this connection handle

Returns
uint8_t

◆ give()

uint8_t SecureClient::give ( )

Give back connection semaphore.

Release exclusive lock of this connection handle

Returns
uint8_t

◆ connect()

uint8_t SecureClient::connect ( )

Initiate a connection with device.

Begins the GAP procedure for a BLE connection

Returns
uint8_t

◆ configure()

uint8_t SecureClient::configure ( )

Configure the device using BLE GATT.

Use our configuration GATT characteristic to send the details of the device configuration to specify the behavior of the connected device.

Returns
uint8_t

◆ close()

uint8_t SecureClient::close ( )

Close the BLE client connection.

Closes the client connecion and ensures all resource states are cleared

Returns
uint8_t
The documentation for this class was generated from the following file: