summaryrefslogtreecommitdiff
path: root/src/components/policy/policy_external/doc/doxygen/components/TransportManager/Client Specification/DeviceManagement.txt
blob: eb5f3e477ebea9a6be0fe33fef4365c4c5c52488 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
/** @page components_transportmanager_client_device_management Device Management
 *
 * As all requests to TransportManager are asynchronous, client must implement NsSmartDeviceLink::NsTransportManager::ITransportManagerDeviceListener
 * interface and add itself as a device listener with NsSmartDeviceLink::NsTransportManager::ITransportManager::addDeviceListener()
 * in order to receive notifications.
 * Client of TransportManager may use NsSmartDeviceLink::NsTransportManager::ITransportManager::scanForNewDevices()
 * to initiate device scan on all device adapters that support this feature. In order to get list of available
 * devices client must override NsSmartDeviceLink::NsTransportManager::ITransportManagerDeviceListener::onDeviceListUpdated().
 * Each device adapter will perform scan independently from other device adapters and device list might be updated
 * several times (after each adapter that supports scanning finishes scanning operation). Device list might also be
 * updated without device scan request, e.g. if new client connects via TCP this device will be added to device list
 * and update notification will be sent to client. In any of these cases client will be provided with the full
 * device list from all device adapters in every notification.
 */