Cordio Singleton support only one instance

Additional instances must be managed by user.

Author: paul-szczepanek-arm

connectivity/FEATURE_BLE/include/ble/BLE.h

@@ -138,19 +138,42 @@ class BLE {
 public:
     /**
      * Opaque type used to store the ID of a BLE instance.
+     * @deprecated BLE singleton supports one instance. You may create multiple instances by using the constructor.
      */
     typedef unsigned InstanceID_t;
 
     /**
      * The value of the BLE::InstanceID_t for the default BLE instance.
+     * @deprecated BLE singleton supports one instance. You may create multiple instances by using the constructor.
      */
     static const InstanceID_t DEFAULT_INSTANCE = 0;
 
     /**
      * The number of permitted BLE instances for the application.
+     * @deprecated BLE singleton supports one instance. You may create multiple instances by using the constructor.
      */
     static const InstanceID_t NUM_INSTANCES = 1;
 
+    /**
+     * Get a reference to the BLE singleton.
+     *
+     * @note Calling Instance() is preferred over constructing a BLE object
+     * directly because it returns a reference to singleton.
+     *
+     * @return A reference to a single object.
+     */
+    static BLE &Instance();
+
+    /**
+     * Constructor for a handle to a BLE instance (the BLE stack). BLE handles
+     * are thin wrappers around a transport object (that is, ptr. to
+     * BLEInstanceBase).
+     *
+     * @param[in] transport Ble transport used for the BLE instance.
+     * @note Cordio supports only one instance.
+     */
+    BLE(BLEInstanceBase &transport);
+
     /**
      * Get a reference to the BLE singleton corresponding to a given interface.
      *
@@ -164,17 +187,23 @@ class BLE {
      * @return A reference to a single object.
      *
      * @pre id shall be less than NUM_INSTANCES.
+     * @deprecated BLE singleton supports one instance. You may create multiple instances by using the constructor.
+     * Please use BLE::Instance().
      */
-    static BLE &Instance(InstanceID_t id = DEFAULT_INSTANCE);
+    static BLE &Instance(InstanceID_t id)
+    {
+        return Instance();
+    }
 
     /**
      * Fetch the ID of a BLE instance.
      *
      * @return Instance id of this BLE instance.
+     * @deprecated BLE singleton supports one instance. You may create multiple instances by using the constructor.
      */
     InstanceID_t getInstanceID(void) const
     {
-        return instanceID;
+        return DEFAULT_INSTANCE;
     }
 
     /**
@@ -412,18 +441,6 @@ class BLE {
      */
     static const char *errorToString(ble_error_t error);
 
-private:
-    friend class BLEInstanceBase;
-
-    /**
-     * Constructor for a handle to a BLE instance (the BLE stack). BLE handles
-     * are thin wrappers around a transport object (that is, ptr. to
-     * BLEInstanceBase).
-     *
-     * @param[in] instanceID BLE Instance ID to get.
-     */
-    BLE(InstanceID_t instanceID = DEFAULT_INSTANCE);
-
     /**
      * This function allows the BLE stack to signal that there is work to do and
      * event processing should be done (BLE::processEvent()).
@@ -433,6 +450,9 @@ class BLE {
      */
     void signalEventsToProcess();
 
+private:
+    friend class BLEInstanceBase;
+
     /**
      * Implementation of init() [internal to BLE_API].
      *
@@ -446,12 +466,10 @@ class BLE {
 private:
     // Prevent copy construction and copy assignment of BLE.
     BLE(const BLE &);
-
     BLE &operator=(const BLE &);
 
 private:
-    InstanceID_t instanceID;
-    BLEInstanceBase *transport; /* The device-specific backend */
+    BLEInstanceBase &transport; /* The device-specific backend */
     OnEventsToProcessCallback_t whenEventsToProcess;
     bool event_signaled;
 };

connectivity/FEATURE_BLE/include/ble/internal/BLEInstanceBase.h

@@ -83,11 +83,12 @@ class BLEInstanceBase
      * ready to be processed in the internal stack or BLE subsystem. As a result
      * of this call, the callback registered by the end user via
      * BLE::onEventsToProcess will be invoked.
-     *
-     * @param[in] id: Identifier of the BLE instance, which does have events to
-     * ready to be processed.
+     * @deprecated Call BLE::signalEventsToProcess directly.
      */
-    void signalEventsToProcess(BLE::InstanceID_t id);
+    virtual void signalEventsToProcess()
+    {
+        BLE::Instance().signalEventsToProcess();
+    };
 
     /**
      * Start the initialization of the vendor BLE subsystem.
@@ -96,8 +97,6 @@ class BLEInstanceBase
      * the BLE instance which issue that call while the initCallback is used to
      * signal asynchronously the completion of the initialization process.
      *
-     * @param[in] instanceID Identifier of the BLE instance requesting
-     * initialization.
      * @param[in] initCallback Callback which the vendor port shall invoke
      * when the initialization completes.
      *
@@ -116,7 +115,6 @@ class BLEInstanceBase
      * @see BLE::init()
      */
     virtual ble_error_t init(
-        BLE::InstanceID_t instanceID,
         FunctionPointerWithContext<BLE::InitializationCompleteCallbackContext*> initCallback
     ) = 0;
 

connectivity/FEATURE_BLE/include/ble/internal/cordio/CordioBLEInstanceBase.h

@@ -67,7 +67,6 @@ class CordioBLEInstanceBase : public BLEInstanceBase {
     * @see BLEInstanceBase::init
     */
     virtual ble_error_t init(
-        ::BLE::InstanceID_t instanceID,
         FunctionPointerWithContext< ::BLE::InitializationCompleteCallbackContext*> initCallback
     );
 
@@ -164,7 +163,6 @@ class CordioBLEInstanceBase : public BLEInstanceBase {
         INITIALIZED
     } initialization_status;
 
-    ::BLE::InstanceID_t instanceID;
     mutable ble::PalEventQueue _event_queue;
     mbed::LowPowerTimer _timer;
     uint64_t _last_update_us;

connectivity/FEATURE_BLE/include/ble/internal/cordio/CordioPalEventQueue.h

@@ -39,25 +39,19 @@ struct PalEventQueue : interface::PalEventQueue {
      * Construct an empty event queue.
      *
      * @attention a call to initialize is mandatory before any other call.
-     *
-     * @param ble_instance_id The id of the ble instance associated with that
-     * event queue.
      */
     PalEventQueue() :
-        _ble_base(NULL), _ble_instance_id(0), _events(NULL) { }
+        _ble_base(NULL), _events(NULL) { }
 
     /**
      * Initialize the event queue with a BLEInstanceBase and a ble id.
      *
      * @param ble_base the instance which will be used to signal the presence
      * of new events.
-     *
-     * @param ble_id Id of the BLE instance using that event queue.
      */
-    void initialize(BLEInstanceBase* ble_base, ::BLE::InstanceID_t ble_id)
+    void initialize(BLEInstanceBase* ble_base)
     {
         _ble_base = ble_base;
-        _ble_instance_id = ble_id;
     }
 
     /**
@@ -138,11 +132,10 @@ struct PalEventQueue : interface::PalEventQueue {
 
     void signal_event()
     {
-        _ble_base->signalEventsToProcess(_ble_instance_id);
+        _ble_base->signalEventsToProcess();
     }
 
     BLEInstanceBase* _ble_base;
-    ::BLE::InstanceID_t _ble_instance_id;
     EventNode* _events;
 };