ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-11-22 13:10:55 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/src/NimBLEServer.h

177 lines
6.2 KiB
C
Raw Normal View History

Initial commit.
2020-03-30 01:44:20 +02:00
/*
* NimBLEServer.h
*
* Created: on March 2, 2020
* Author H2zero
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
*
Initial commit.
2020-03-30 01:44:20 +02:00
* Originally:
*
* BLEServer.h
*
* Created on: Apr 16, 2017
* Author: kolban
*/
#ifndef MAIN_NIMBLESERVER_H_
#define MAIN_NIMBLESERVER_H_
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#include "nimconfig.h"
Refactor include directives to use different paths for arduino/idf. * Sets macros to allow compiling when Central role is enabled and Observer disabled, or Peripheral enabled and Broadcaster disabled. * Adds a macro definition for CONFIG_NIMBLE_CPP_IDF to enable different include paths/functionality for IDF / Arduino.
2021-09-07 05:14:43 +02:00
#if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
[Server] Implement remove Characteristics/Descriptors. (#54) This allows for adding and removing of characteristics and descriptors after initial setup of the server. When used it will send a service changed notification to all clients. The changes will not take effect until all clients have disconnected and advertising restarted.
2021-07-31 04:56:52 +02:00
#define NIMBLE_ATT_REMOVE_HIDE 1
#define NIMBLE_ATT_REMOVE_DELETE 2
Update NimBLEServer.h (#65)
2022-01-02 02:00:45 +01:00
#define onMtuChanged onMTUChange
Remove semaphores, use task notifications instead.
2020-06-11 16:06:16 +02:00
#include "NimBLEUtils.h"
Initial commit.
2020-03-30 01:44:20 +02:00
#include "NimBLEAddress.h"
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
#if CONFIG_BT_NIMBLE_EXT_ADV
#include "NimBLEExtAdvertising.h"
#else
Initial commit.
2020-03-30 01:44:20 +02:00
#include "NimBLEAdvertising.h"
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
#endif
Initial commit.
2020-03-30 01:44:20 +02:00
#include "NimBLEService.h"
Add connection info class and access methods to server and client. This adds the ability to access information about the current connection. A new class was created to wrap the struct ble_gap_conn_desc with methods to retrieve the connection information. Example server use: ``` for(auto i=0; i<pServer->getConnectedCount();i++) { NimBLEConnInfo connInfo = pServer->getPeerInfo(i); printf("Connected client %d info:\n", i); printf("Peer address: %s\n", connInfo.getAddress().toString().c_str()); printf("Peer ID address: %s\n", connInfo.getIdAddress().toString().c_str()); printf("Handle: %u\n", connInfo.getConnHandle()); printf("Interval: %u\n", connInfo.getConnInterval()); printf("Timeout: %u\n", connInfo.getConnTimeout()); printf("Latency: %u\n", connInfo.getConnLatency()); printf("MTU: %u\n", connInfo.getMTU()); printf("Master: %s\n", connInfo.isMaster()? "true":"false"); printf("Slave: %s\n", connInfo.isSlave()? "true":"false"); printf("Bonded: %s\n", connInfo.isBonded()? "true":"false"); printf("Authenticated: %s\n", connInfo.isAuthenticated()? "true":"false"); printf("Encrypted: %s\n", connInfo.isEncrypted()? "true":"false"); printf("Encryption Key Size: %u\n", connInfo.getSecKeySize()); } ``` Example client use: ``` if (pClient->isConnected()) { NimBLEConnInfo connInfo = pClient->getConnInfo(); printf("Connection info:\n"); printf("Peer address: %s\n", connInfo.getAddress().toString().c_str()); printf("Peer ID address: %s\n", connInfo.getIdAddress().toString().c_str()); printf("Handle: %u\n", connInfo.getConnHandle()); printf("Interval: %u\n", connInfo.getConnInterval()); printf("Timeout: %u\n", connInfo.getConnTimeout()); printf("Latency: %u\n", connInfo.getConnLatency()); printf("MTU: %u\n", connInfo.getMTU()); printf("Master: %s\n", connInfo.isMaster()? "true":"false"); printf("Slave: %s\n", connInfo.isSlave()? "true":"false"); printf("Bonded: %s\n", connInfo.isBonded()? "true":"false"); printf("Authenticated: %s\n", connInfo.isAuthenticated()? "true":"false"); printf("Encrypted: %s\n", connInfo.isEncrypted()? "true":"false"); printf("Encryption Key Size: %u\n", connInfo.getSecKeySize()); } ```
2021-05-07 17:02:43 +02:00
#include "NimBLEConnInfo.h"
Remove semaphores, use task notifications instead.
2020-06-11 16:06:16 +02:00
Initial commit.
2020-03-30 01:44:20 +02:00
class NimBLEService;
class NimBLECharacteristic;
class NimBLEServerCallbacks;
/**
* @brief The model of a %BLE server.
*/
class NimBLEServer {
public:
Refactor server code to use vectors instead of maps. * Use critical sections to access characteristic/descriptor value data. * Remove unnecessary code * Create characteristic semaphore only if needed for indications. * Fix advertising when not broadcasting a service.
2020-06-08 02:42:28 +02:00
size_t getConnectedCount();
NimBLEService* createService(const char* uuid);
[NimBLEService] Remove unused variables/parameters.
2021-12-29 16:12:07 +01:00
NimBLEService* createService(const NimBLEUUID &uuid);
Add feature: remove service (#17) * Get service handles on server start * remove service + indicate service changed * Reset gatt services when no connections active and services changed. * NimBLEServer::createService can now be used any time and will send service changed indication if server was already active. * Add ability to remove advertised serviceUUIDS * Adds addService() method to server to be allow user to re-add a service previously removed * Add destructior to NimBLEServer, NimBLEService and NimBLECharacteristic to release allocated resources.
2020-07-14 05:24:07 +02:00
void removeService(NimBLEService* service, bool deleteSvc = false);
void addService(NimBLEService* service);
Add clearAll parameter to deinit() (#22) * Add clearAll parameter to deinit() Adds the ability to clear all resources consumed during BLE operation when deinitializing and shutting down BLE. Useful when BLE is used intermittently or in a task that initializes, performs operations then deinitializes. By setting the clearAll parameter to true all created BLE objects will be deleted, freeing the memory for other tasks. Warning: This will invalidate any pointers that may be referencing the deleted objects. * Add bool deleteCallbacks parameter to NimBLEServer::setCallbacks, if true (default) will delete the callback class when server is destructed. * Delete scan results when scan is destructed.
2020-07-29 04:57:33 +02:00
void setCallbacks(NimBLEServerCallbacks* pCallbacks,
bool deleteCallbacks = true);
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
#if CONFIG_BT_NIMBLE_EXT_ADV
NimBLEExtAdvertising* getAdvertising();
bool startAdvertising(uint8_t inst_id,
int duration = 0,
int max_events = 0);
bool stopAdvertising(uint8_t inst_id);
Add docs build.
2022-08-27 20:38:53 +02:00
#endif
# if !CONFIG_BT_NIMBLE_EXT_ADV || defined(_DOXYGEN_)
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
NimBLEAdvertising* getAdvertising();
[Breaking] Change all time input parameters to milliseconds. (#78) Changes all functions that accept a time parameter to use milliseconds instead of seconds. * Adds duration input to NimBLEDevice::startAdvertising and NimBLEServer::startAdvertising.
2022-08-27 03:32:01 +02:00
bool startAdvertising(uint32_t duration = 0);
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
#endif
bool stopAdvertising();
Refactor server code to use vectors instead of maps. * Use critical sections to access characteristic/descriptor value data. * Remove unnecessary code * Create characteristic semaphore only if needed for indications. * Fix advertising when not broadcasting a service.
2020-06-08 02:42:28 +02:00
void start();
[NimBLEServer] Support duplicate characteristics (#36) * Add method to get all characteristics of a service * Added method on NimBLEDescriptor to get the value out as a std::string * Added methods to get things by handle where UUID could be used already. * Added helper methods for getting a list of characteristics with a given UUID and service * Demote the warning log for adding duplicate characteristics to a debug level log. * Add methods to get services and characteristics using UUID + index
2021-02-08 16:28:32 +01:00
NimBLEService* getServiceByUUID(const char* uuid, uint16_t instanceId = 0);
NimBLEService* getServiceByUUID(const NimBLEUUID &uuid, uint16_t instanceId = 0);
NimBLEService* getServiceByHandle(uint16_t handle);
Refactor server code to use vectors instead of maps. * Use critical sections to access characteristic/descriptor value data. * Remove unnecessary code * Create characteristic semaphore only if needed for indications. * Fix advertising when not broadcasting a service.
2020-06-08 02:42:28 +02:00
int disconnect(uint16_t connID,
uint8_t reason = BLE_ERR_REM_USER_CONN_TERM);
void updateConnParams(uint16_t conn_handle,
uint16_t minInterval, uint16_t maxInterval,
uint16_t latency, uint16_t timeout);
[Server][Client] Add function to set data length. Enables the use of BLE data length extension to improve data transfer rates.
2021-09-13 03:09:02 +02:00
void setDataLen(uint16_t conn_handle, uint16_t tx_octets);
Refactor server code to use vectors instead of maps. * Use critical sections to access characteristic/descriptor value data. * Remove unnecessary code * Create characteristic semaphore only if needed for indications. * Fix advertising when not broadcasting a service.
2020-06-08 02:42:28 +02:00
uint16_t getPeerMTU(uint16_t conn_id);
Add connection info class and access methods to server and client. This adds the ability to access information about the current connection. A new class was created to wrap the struct ble_gap_conn_desc with methods to retrieve the connection information. Example server use: ``` for(auto i=0; i<pServer->getConnectedCount();i++) { NimBLEConnInfo connInfo = pServer->getPeerInfo(i); printf("Connected client %d info:\n", i); printf("Peer address: %s\n", connInfo.getAddress().toString().c_str()); printf("Peer ID address: %s\n", connInfo.getIdAddress().toString().c_str()); printf("Handle: %u\n", connInfo.getConnHandle()); printf("Interval: %u\n", connInfo.getConnInterval()); printf("Timeout: %u\n", connInfo.getConnTimeout()); printf("Latency: %u\n", connInfo.getConnLatency()); printf("MTU: %u\n", connInfo.getMTU()); printf("Master: %s\n", connInfo.isMaster()? "true":"false"); printf("Slave: %s\n", connInfo.isSlave()? "true":"false"); printf("Bonded: %s\n", connInfo.isBonded()? "true":"false"); printf("Authenticated: %s\n", connInfo.isAuthenticated()? "true":"false"); printf("Encrypted: %s\n", connInfo.isEncrypted()? "true":"false"); printf("Encryption Key Size: %u\n", connInfo.getSecKeySize()); } ``` Example client use: ``` if (pClient->isConnected()) { NimBLEConnInfo connInfo = pClient->getConnInfo(); printf("Connection info:\n"); printf("Peer address: %s\n", connInfo.getAddress().toString().c_str()); printf("Peer ID address: %s\n", connInfo.getIdAddress().toString().c_str()); printf("Handle: %u\n", connInfo.getConnHandle()); printf("Interval: %u\n", connInfo.getConnInterval()); printf("Timeout: %u\n", connInfo.getConnTimeout()); printf("Latency: %u\n", connInfo.getConnLatency()); printf("MTU: %u\n", connInfo.getMTU()); printf("Master: %s\n", connInfo.isMaster()? "true":"false"); printf("Slave: %s\n", connInfo.isSlave()? "true":"false"); printf("Bonded: %s\n", connInfo.isBonded()? "true":"false"); printf("Authenticated: %s\n", connInfo.isAuthenticated()? "true":"false"); printf("Encrypted: %s\n", connInfo.isEncrypted()? "true":"false"); printf("Encryption Key Size: %u\n", connInfo.getSecKeySize()); } ```
2021-05-07 17:02:43 +02:00
std::vector<uint16_t> getPeerDevices();
NimBLEConnInfo getPeerInfo(size_t index);
NimBLEConnInfo getPeerInfo(const NimBLEAddress& address);
NimBLEConnInfo getPeerIDInfo(uint16_t id);
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
#if !CONFIG_BT_NIMBLE_EXT_ADV || defined(_DOXYGEN_)
Refactor server code to use vectors instead of maps. * Use critical sections to access characteristic/descriptor value data. * Remove unnecessary code * Create characteristic semaphore only if needed for indications. * Fix advertising when not broadcasting a service.
2020-06-08 02:42:28 +02:00
void advertiseOnDisconnect(bool);
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
#endif
Initial commit.
2020-03-30 01:44:20 +02:00
private:
NimBLEServer();
Add feature: remove service (#17) * Get service handles on server start * remove service + indicate service changed * Reset gatt services when no connections active and services changed. * NimBLEServer::createService can now be used any time and will send service changed indication if server was already active. * Add ability to remove advertised serviceUUIDS * Adds addService() method to server to be allow user to re-add a service previously removed * Add destructior to NimBLEServer, NimBLEService and NimBLECharacteristic to release allocated resources.
2020-07-14 05:24:07 +02:00
~NimBLEServer();
Refactor server code to use vectors instead of maps. * Use critical sections to access characteristic/descriptor value data. * Remove unnecessary code * Create characteristic semaphore only if needed for indications. * Fix advertising when not broadcasting a service.
2020-06-08 02:42:28 +02:00
friend class NimBLECharacteristic;
[Server] Implement remove Characteristics/Descriptors. (#54) This allows for adding and removing of characteristics and descriptors after initial setup of the server. When used it will send a service changed notification to all clients. The changes will not take effect until all clients have disconnected and advertising restarted.
2021-07-31 04:56:52 +02:00
friend class NimBLEService;
Refactor server code to use vectors instead of maps. * Use critical sections to access characteristic/descriptor value data. * Remove unnecessary code * Create characteristic semaphore only if needed for indications. * Fix advertising when not broadcasting a service.
2020-06-08 02:42:28 +02:00
friend class NimBLEDevice;
friend class NimBLEAdvertising;
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
#if CONFIG_BT_NIMBLE_EXT_ADV
friend class NimBLEExtAdvertising;
friend class NimBLEExtAdvertisementData;
#endif
Refactor server code to use vectors instead of maps. * Use critical sections to access characteristic/descriptor value data. * Remove unnecessary code * Create characteristic semaphore only if needed for indications. * Fix advertising when not broadcasting a service.
2020-06-08 02:42:28 +02:00
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
bool m_gattsStarted;
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
#if !CONFIG_BT_NIMBLE_EXT_ADV
Refactor server code to use vectors instead of maps. * Use critical sections to access characteristic/descriptor value data. * Remove unnecessary code * Create characteristic semaphore only if needed for indications. * Fix advertising when not broadcasting a service.
2020-06-08 02:42:28 +02:00
bool m_advertiseOnDisconnect;
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
#endif
Add feature: remove service (#17) * Get service handles on server start * remove service + indicate service changed * Reset gatt services when no connections active and services changed. * NimBLEServer::createService can now be used any time and will send service changed indication if server was already active. * Add ability to remove advertised serviceUUIDS * Adds addService() method to server to be allow user to re-add a service previously removed * Add destructior to NimBLEServer, NimBLEService and NimBLECharacteristic to release allocated resources.
2020-07-14 05:24:07 +02:00
bool m_svcChanged;
Refactor server code to use vectors instead of maps. * Use critical sections to access characteristic/descriptor value data. * Remove unnecessary code * Create characteristic semaphore only if needed for indications. * Fix advertising when not broadcasting a service.
2020-06-08 02:42:28 +02:00
NimBLEServerCallbacks* m_pServerCallbacks;
Add clearAll parameter to deinit() (#22) * Add clearAll parameter to deinit() Adds the ability to clear all resources consumed during BLE operation when deinitializing and shutting down BLE. Useful when BLE is used intermittently or in a task that initializes, performs operations then deinitializes. By setting the clearAll parameter to true all created BLE objects will be deleted, freeing the memory for other tasks. Warning: This will invalidate any pointers that may be referencing the deleted objects. * Add bool deleteCallbacks parameter to NimBLEServer::setCallbacks, if true (default) will delete the callback class when server is destructed. * Delete scan results when scan is destructed.
2020-07-29 04:57:33 +02:00
bool m_deleteCallbacks;
Remove task notification for server indications. This resolves an issue when sending an indication from a callback that can cause the server to hang.
2021-05-17 22:08:02 +02:00
uint16_t m_indWait[CONFIG_BT_NIMBLE_MAX_CONNECTIONS];
Refactor server code to use vectors instead of maps. * Use critical sections to access characteristic/descriptor value data. * Remove unnecessary code * Create characteristic semaphore only if needed for indications. * Fix advertising when not broadcasting a service.
2020-06-08 02:42:28 +02:00
std::vector<uint16_t> m_connectedPeersVec;
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
Refactor server code to use vectors instead of maps. * Use critical sections to access characteristic/descriptor value data. * Remove unnecessary code * Create characteristic semaphore only if needed for indications. * Fix advertising when not broadcasting a service.
2020-06-08 02:42:28 +02:00
// uint16_t m_svcChgChrHdl; // Future use
Initial commit.
2020-03-30 01:44:20 +02:00
Refactor server code to use vectors instead of maps. * Use critical sections to access characteristic/descriptor value data. * Remove unnecessary code * Create characteristic semaphore only if needed for indications. * Fix advertising when not broadcasting a service.
2020-06-08 02:42:28 +02:00
std::vector<NimBLEService*> m_svcVec;
std::vector<NimBLECharacteristic*> m_notifyChrVec;
Initial commit.
2020-03-30 01:44:20 +02:00
Refactor server code to use vectors instead of maps. * Use critical sections to access characteristic/descriptor value data. * Remove unnecessary code * Create characteristic semaphore only if needed for indications. * Fix advertising when not broadcasting a service.
2020-06-08 02:42:28 +02:00
static int handleGapEvent(struct ble_gap_event *event, void *arg);
[Server] Implement remove Characteristics/Descriptors. (#54) This allows for adding and removing of characteristics and descriptors after initial setup of the server. When used it will send a service changed notification to all clients. The changes will not take effect until all clients have disconnected and advertising restarted.
2021-07-31 04:56:52 +02:00
void serviceChanged();
Add feature: remove service (#17) * Get service handles on server start * remove service + indicate service changed * Reset gatt services when no connections active and services changed. * NimBLEServer::createService can now be used any time and will send service changed indication if server was already active. * Add ability to remove advertised serviceUUIDS * Adds addService() method to server to be allow user to re-add a service previously removed * Add destructior to NimBLEServer, NimBLEService and NimBLECharacteristic to release allocated resources.
2020-07-14 05:24:07 +02:00
void resetGATT();
Remove task notification for server indications. This resolves an issue when sending an indication from a callback that can cause the server to hang.
2021-05-17 22:08:02 +02:00
bool setIndicateWait(uint16_t conn_handle);
void clearIndicateWait(uint16_t conn_handle);
Initial commit.
2020-03-30 01:44:20 +02:00
}; // NimBLEServer
/**
* @brief Callbacks associated with the operation of a %BLE server.
*/
class NimBLEServerCallbacks {
public:
virtual ~NimBLEServerCallbacks() {};
Fix comments for doxygen (#16) * Fix comments for doxygen * Add documentation and update readme.
2020-07-09 03:27:26 +02:00
Initial commit.
2020-03-30 01:44:20 +02:00
/**
Fix comments for doxygen (#16) * Fix comments for doxygen * Add documentation and update readme.
2020-07-09 03:27:26 +02:00
* @brief Handle a client connection.
* This is called when a client connects.
* @param [in] pServer A pointer to the %BLE server that received the client connection.
[Breaking] Update callbacks to use NimBLEConnInfo. Change the callback functions that receive a ble_gap_conn_desc pointer to instead receive a NimBLEConnInfo reference. * Add a reason parameter to the server disconnect callback. * Remove connect and disconnect callback that do not receive info parameters. * Remove onRead and onWrite Characteristic callbacks that do not receive info parameters. * Add info parameter to Descriptor onWrite and onRead callbacks. * Add details to migration guide.
2022-08-27 16:28:15 +02:00
* @param [in] connInfo A reference to a NimBLEConnInfo instance with information
* about the peer connection parameters.
Initial commit.
2020-03-30 01:44:20 +02:00
*/
[Breaking] Update callbacks to use NimBLEConnInfo. Change the callback functions that receive a ble_gap_conn_desc pointer to instead receive a NimBLEConnInfo reference. * Add a reason parameter to the server disconnect callback. * Remove connect and disconnect callback that do not receive info parameters. * Remove onRead and onWrite Characteristic callbacks that do not receive info parameters. * Add info parameter to Descriptor onWrite and onRead callbacks. * Add details to migration guide.
2022-08-27 16:28:15 +02:00
virtual void onConnect(NimBLEServer* pServer, NimBLEConnInfo& connInfo);
Fix comments for doxygen (#16) * Fix comments for doxygen * Add documentation and update readme.
2020-07-09 03:27:26 +02:00
Initial commit.
2020-03-30 01:44:20 +02:00
/**
Add connection desc param to disconnect callback.
2020-12-05 03:03:52 +01:00
* @brief Handle a client disconnection.
* This is called when a client discconnects.
* @param [in] pServer A pointer to the %BLE server that received the client disconnection.
[Breaking] Update callbacks to use NimBLEConnInfo. Change the callback functions that receive a ble_gap_conn_desc pointer to instead receive a NimBLEConnInfo reference. * Add a reason parameter to the server disconnect callback. * Remove connect and disconnect callback that do not receive info parameters. * Remove onRead and onWrite Characteristic callbacks that do not receive info parameters. * Add info parameter to Descriptor onWrite and onRead callbacks. * Add details to migration guide.
2022-08-27 16:28:15 +02:00
* @param [in] connInfo A reference to a NimBLEConnInfo instance with information
* about the peer connection parameters.
* @param [in] reason The reason code for the disconnection.
Add connection desc param to disconnect callback.
2020-12-05 03:03:52 +01:00
*/
[Breaking] Update callbacks to use NimBLEConnInfo. Change the callback functions that receive a ble_gap_conn_desc pointer to instead receive a NimBLEConnInfo reference. * Add a reason parameter to the server disconnect callback. * Remove connect and disconnect callback that do not receive info parameters. * Remove onRead and onWrite Characteristic callbacks that do not receive info parameters. * Add info parameter to Descriptor onWrite and onRead callbacks. * Add details to migration guide.
2022-08-27 16:28:15 +02:00
virtual void onDisconnect(NimBLEServer* pServer, NimBLEConnInfo& connInfo, int reason);
Add connection desc param to disconnect callback.
2020-12-05 03:03:52 +01:00
[Breaking] Update callbacks to use NimBLEConnInfo. Change the callback functions that receive a ble_gap_conn_desc pointer to instead receive a NimBLEConnInfo reference. * Add a reason parameter to the server disconnect callback. * Remove connect and disconnect callback that do not receive info parameters. * Remove onRead and onWrite Characteristic callbacks that do not receive info parameters. * Add info parameter to Descriptor onWrite and onRead callbacks. * Add details to migration guide.
2022-08-27 16:28:15 +02:00
/**
[Server] Add callback for MTU change. (#55) onMTUChange callback added that is called when a connection MTU is updated.
2021-07-20 05:47:59 +02:00
* @brief Called when the connection MTU changes.
* @param [in] MTU The new MTU value.
[Breaking] Update callbacks to use NimBLEConnInfo. Change the callback functions that receive a ble_gap_conn_desc pointer to instead receive a NimBLEConnInfo reference. * Add a reason parameter to the server disconnect callback. * Remove connect and disconnect callback that do not receive info parameters. * Remove onRead and onWrite Characteristic callbacks that do not receive info parameters. * Add info parameter to Descriptor onWrite and onRead callbacks. * Add details to migration guide.
2022-08-27 16:28:15 +02:00
* @param [in] connInfo A reference to a NimBLEConnInfo instance with information
* about the peer connection parameters.
[Server] Add callback for MTU change. (#55) onMTUChange callback added that is called when a connection MTU is updated.
2021-07-20 05:47:59 +02:00
*/
[Breaking] Update callbacks to use NimBLEConnInfo. Change the callback functions that receive a ble_gap_conn_desc pointer to instead receive a NimBLEConnInfo reference. * Add a reason parameter to the server disconnect callback. * Remove connect and disconnect callback that do not receive info parameters. * Remove onRead and onWrite Characteristic callbacks that do not receive info parameters. * Add info parameter to Descriptor onWrite and onRead callbacks. * Add details to migration guide.
2022-08-27 16:28:15 +02:00
virtual void onMTUChange(uint16_t MTU, NimBLEConnInfo& connInfo);
[Server] Add callback for MTU change. (#55) onMTUChange callback added that is called when a connection MTU is updated.
2021-07-20 05:47:59 +02:00
Fix comments for doxygen (#16) * Fix comments for doxygen * Add documentation and update readme.
2020-07-09 03:27:26 +02:00
/**
* @brief Called when a client requests a passkey for pairing.
* @return The passkey to be sent to the client.
*/
virtual uint32_t onPassKeyRequest();
/**
* @brief Called when the pairing procedure is complete.
[Breaking] Update callbacks to use NimBLEConnInfo. Change the callback functions that receive a ble_gap_conn_desc pointer to instead receive a NimBLEConnInfo reference. * Add a reason parameter to the server disconnect callback. * Remove connect and disconnect callback that do not receive info parameters. * Remove onRead and onWrite Characteristic callbacks that do not receive info parameters. * Add info parameter to Descriptor onWrite and onRead callbacks. * Add details to migration guide.
2022-08-27 16:28:15 +02:00
* @param [in] connInfo A reference to a NimBLEConnInfo instance with information
* about the peer connection parameters.
Fix comments for doxygen (#16) * Fix comments for doxygen * Add documentation and update readme.
2020-07-09 03:27:26 +02:00
*/
[Breaking] Update callbacks to use NimBLEConnInfo. Change the callback functions that receive a ble_gap_conn_desc pointer to instead receive a NimBLEConnInfo reference. * Add a reason parameter to the server disconnect callback. * Remove connect and disconnect callback that do not receive info parameters. * Remove onRead and onWrite Characteristic callbacks that do not receive info parameters. * Add info parameter to Descriptor onWrite and onRead callbacks. * Add details to migration guide.
2022-08-27 16:28:15 +02:00
virtual void onAuthenticationComplete(NimBLEConnInfo& connInfo);
Fix comments for doxygen (#16) * Fix comments for doxygen * Add documentation and update readme.
2020-07-09 03:27:26 +02:00
/**
* @brief Called when using numeric comparision for pairing.
* @param [in] pin The pin to compare with the client.
* @return True to accept the pin.
*/
virtual bool onConfirmPIN(uint32_t pin);
Refactor server code to use vectors instead of maps. * Use critical sections to access characteristic/descriptor value data. * Remove unnecessary code * Create characteristic semaphore only if needed for indications. * Fix advertising when not broadcasting a service.
2020-06-08 02:42:28 +02:00
}; // NimBLEServerCallbacks
Initial commit.
2020-03-30 01:44:20 +02:00
Refactor include directives to use different paths for arduino/idf. * Sets macros to allow compiling when Central role is enabled and Observer disabled, or Peripheral enabled and Broadcaster disabled. * Adds a macro definition for CONFIG_NIMBLE_CPP_IDF to enable different include paths/functionality for IDF / Arduino.
2021-09-07 05:14:43 +02:00
#endif /* CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_PERIPHERAL */
Add ==,!= operators to NimBLEAddress, pass parameters by const reference.
2020-05-10 15:21:46 +02:00
#endif /* MAIN_NIMBLESERVER_H_ */
Reference in a new issue Copy permalink