BLEInstanceBase Class Reference
[Porting]

Base constructor.

Definition at line 60 of file BLEInstanceBase.h.

Virtual destructor of the interface.

Definition at line 20 of file BLEInstanceBase.cpp.

Accessor to the vendor implementation of the Gap interface.

Returns:

A reference to a Gap object associated to this BLEInstanceBase instance.

See also:

BLE::gap() Gap

Const alternative to getGap().

Returns:

A const reference to a Gap object associated to this BLEInstanceBase instance.

See also:

BLE::gap() Gap

Accessor to the vendor implementation of the GattClient interface.

Returns:

A reference to a GattClient object associated to this BLEInstanceBase instance.

See also:

BLE::gattClient() GattClient

Accessor to the vendor implementation of the GattServer interface.

Returns:

A reference to a GattServer object associated to this BLEInstanceBase instance.

See also:

BLE::gattServer() GattServer

A const alternative to getGattServer().

Returns:

A const reference to a GattServer object associated to this BLEInstanceBase instance.

See also:

BLE::gattServer() GattServer

Accessor to the vendor implementation of the SecurityManager interface.

Returns:

A reference to a SecurityManager object associated to this BLEInstanceBase instance.

See also:

BLE::securityManager() SecurityManager

A const alternative to getSecurityManager().

Returns:

A const reference to a SecurityManager object associated to this BLEInstancebase instance.

See also:

BLE::securityManager() SecurityManager

Fetches a NULL terminated string representation of the underlying BLE vendor subsystem.

Returns:

A pointer to the NULL terminated string representation of the underlying BLE stack's version.

See also:

BLE::getVersion()

Check whether the vendor BLE subsystem has been initialized or not.

Returns:

true if the initialization has completed for the vendor BLE subsystem.

Note:

this function is invoked by BLE::hasInitialized()

See also:

BLE::init() BLE::hasInitialized()

Start the initialization of the vendor BLE subsystem.

Calls to this function are initiated by BLE::init, instanceID identify the BLE instance which issue that call while the initCallback is used to signal asynchronously the completion of the initialization process.

Parameters:

[in]	instanceID	Identifier of the BLE instance requesting initialization.
[in]	initCallback	Callback which the vendor port shall invoke when the initialization completes.

This is an optional parameter set to NULL when not supplied.

Returns:

BLE_ERROR_NONE if the initialization procedure started successfully.

Postcondition:

initCallback shall be invoked upon completion of the initialization process.

hasInitialized() shall return false until the initialization is complete, and it shall return true after succesful completion of the initialization process.

See also:

BLE::init()

Process ALL pending events living in the vendor BLE subsystem.

Return once all pending events have been consumed.

See also:

BLE::processEvents()

Shutdown the vendor BLE subsystem.

This operation includes purging the stack of GATT and GAP state and clearing all state from other BLE components, such as the SecurityManager. Clearing all states may be realized by a call to Gap::reset(), GattClient::reset(), GattServer::reset() and SecurityManager::reset().

BLE::init() must be called afterward to reinstantiate services and GAP state.

Returns:

BLE_ERROR_NONE if the underlying stack and all other services of the BLE API were shut down correctly.

Postcondition:

hasInitialized() shall return false.

Note:

This function is invoked by BLE::shutdown().

See also:

BLE::shutdown() BLE::init() BLE::hasInitialized() Gap::reset() GattClient::reset() GattServer::reset() SecurityManager::reset() .

Signal to BLE that events needing processing are available.

The vendor port shall call this function whenever there are events 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.

Parameters:

[in]

id,:

Identifier of the BLE instance, which does have events to ready to be processed.

Definition at line 25 of file BLEInstanceBase.cpp.

Process pending events present in the vendor subsystem; then, put the MCU to sleep until an external source wakes it up.

This function is deprecated in the BLE class. It will be removed from this interface once it is removed from BLE.

See also:

BLE::waitForEvent() BLE::processEvents()