BLEServer Class Reference

The model of a BLE server. More...

#include <BLEServer.hpp>

Public Member Functions
uint32_t	getConnectedCount ()
	Return the number of connected clients. More...
BLEService *	createService (const char *uuid)
	Create a BLE Service. More...
BLEService *	createService (BLEUUID uuid, uint32_t numHandles=15, uint8_t inst_id=0)
	Create a BLE Service. More...
BLEAdvertising *	getAdvertising ()
	Retrieve the advertising object that can be used to advertise the existence of the server. More...
void	setCallbacks (BLEServerCallbacks *pCallbacks)
	Set the server callbacks. More...
void	startAdvertising ()
void	removeService (BLEService *service)
BLEService *	getServiceByUUID (const char *uuid)
	Get a BLE Service by its UUID. More...
BLEService *	getServiceByUUID (BLEUUID uuid)
	Get a BLE Service by its UUID. More...
bool	connect (BLEAddress address)
void	disconnect (uint16_t connId)
void	updateConnParams (BLEAddress &remote_bda, uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout)

Public Attributes
uint16_t	m_appId

Detailed Description

The model of a BLE server.

Member Function Documentation

createService() [1/2]

BLEService * BLEServer::createService	(	BLEUUID	uuid,
		uint32_t	numHandles = 15,
		uint8_t	inst_id = 0
	)

Create a BLE Service.

With a BLE server, we can host one or more services. Invoking this function causes the creation of a definition of a new service. Every service must have a unique UUID.

Parameters

[in]	uuid	The UUID of the new service.
[in]	numHandles	The maximum number of handles associated with this service.
[in]	inst_id	With multiple services with the same UUID we need to provide inst_id value different for each service.

Returns

A reference to the new service object.

                                                                                       {
    _debug_print_s(TAG, ">> createService", uuid.toString().c_str());
#ifndef SOFTDEVICE_PRESENT
    m_spinlockCreateEvt.take();
#endif
 
    // Check that a service with the supplied UUID does not already exist.
    if (m_serviceMap.getByUUID(uuid) != nullptr) {
        _debug_print_s(TAG, "<< Attempt to create a new service with uuid %s but a service with that UUID already exists.",
                   uuid.toString().c_str());
    }
 
    BLEService* pService = new BLEService(uuid, numHandles);
    pService->m_instId = inst_id;
    m_serviceMap.setByUUID(uuid, pService); // Save a reference to this service being on this server.
    pService->executeCreate(this);          // Perform the API calls to actually create the service.
#ifndef SOFTDEVICE_PRESENT
    m_spinlockCreateEvt.wait();
#endif
    debug_print(TAG, "<< createService");
    return pService;
} // createService

createService() [2/2]

BLEService * BLEServer::createService

(

const char *

uuid

)

Create a BLE Service.

With a BLE server, we can host one or more services. Invoking this function causes the creation of a definition of a new service. Every service must have a unique UUID.

Parameters

[in]

uuid

The UUID of the new service.

Returns

A reference to the new service object.

                                                     {
    return createService(BLEUUID(uuid));
}

getAdvertising()

BLEAdvertising * BLEServer::getAdvertising

(

)

Retrieve the advertising object that can be used to advertise the existence of the server.

Returns

An advertising object.

                                          {
    return BLEDevice::getAdvertising();
}

getConnectedCount()

uint32_t BLEServer::getConnectedCount

(

)

Return the number of connected clients.

Returns

The number of connected clients.

                                      {
    return m_connectedServersMap.size();
} // getConnectedCount

getServiceByUUID() [1/2]

BLEService * BLEServer::getServiceByUUID

(

BLEUUID

uuid

)

Get a BLE Service by its UUID.

Parameters

[in]

uuid

The UUID of the new service.

Returns

A reference to the service object.

                                                    {
    return m_serviceMap.getByUUID(uuid);
}

getServiceByUUID() [2/2]

BLEService * BLEServer::getServiceByUUID

(

const char *

uuid

)

Get a BLE Service by its UUID.

Parameters

[in]

uuid

The UUID of the new service.

Returns

A reference to the service object.

                                                        {
    return m_serviceMap.getByUUID(uuid);
}

setCallbacks()

void BLEServer::setCallbacks

(

BLEServerCallbacks *

pCallbacks

)

Set the server callbacks.

As a BLE server operates, it will generate server level events such as a new client connecting or a previous client disconnecting. This function can be called to register a callback handler that will be invoked when these events are detected.

Parameters

[in]

pCallbacks

The callbacks to be invoked.

                                                           {
    m_pServerCallbacks = pCallbacks;
} // setCallbacks

---

The documentation for this class was generated from the following files:

• nola-sdk/include/BLEServer.hpp
• src/net/BluetoothLE/BLEServer.cpp