summaryrefslogtreecommitdiff
path: root/src/components/transport_manager/include
diff options
context:
space:
mode:
authorAndrey Oleynik (GitHub) <aoleynik@luxoft.com>2017-09-21 17:40:49 +0300
committerAndriy Byzhynar <AByzhynar@luxoft.com>2018-01-18 11:28:38 +0200
commit8fa4f3b498916b89552394d25f9482ce4b06de5a (patch)
tree3661ecaf592fa16571f32d32917426b6b49047a8 /src/components/transport_manager/include
parenta4af51700fe245aff66250c93f78741dc96584cb (diff)
downloadsdl_core-8fa4f3b498916b89552394d25f9482ce4b06de5a.tar.gz
Adds descriptions, removes unused code
Diffstat (limited to 'src/components/transport_manager/include')
-rw-r--r--src/components/transport_manager/include/transport_manager/transport_adapter/transport_adapter_impl.h12
-rw-r--r--src/components/transport_manager/include/transport_manager/transport_adapter/transport_adapter_listener.h5
-rw-r--r--src/components/transport_manager/include/transport_manager/transport_adapter/transport_adapter_listener_impl.h5
-rw-r--r--src/components/transport_manager/include/transport_manager/transport_manager_impl.h26
4 files changed, 45 insertions, 3 deletions
diff --git a/src/components/transport_manager/include/transport_manager/transport_adapter/transport_adapter_impl.h b/src/components/transport_manager/include/transport_manager/transport_adapter/transport_adapter_impl.h
index 8d1b96bbfd..e4d70d5b07 100644
--- a/src/components/transport_manager/include/transport_manager/transport_adapter/transport_adapter_impl.h
+++ b/src/components/transport_manager/include/transport_manager/transport_adapter/transport_adapter_impl.h
@@ -408,8 +408,20 @@ class TransportAdapterImpl : public TransportAdapter,
*/
std::string DeviceName(const DeviceUID& device_id) const OVERRIDE;
+ /**
+ * @brief StopDevice looks for specific device in devices list and calls
+ * Stop() interface of that device
+ * @param device_id unique device identifier that has to be stopped.
+ */
void StopDevice(const DeviceUID& device_id) const FINAL;
+ /**
+ * @brief DeviceSwitched is triggered for adapter to proceed with possible
+ * further switching steps required on device side. E.g. to notify device
+ * on end of switching so it can disconnect transport being switched from.
+ * This is default implemenation does nothing. Must be overloaded if needed.
+ * @param device_handle Device id to notify on event
+ */
void DeviceSwitched(const DeviceUID& device_handle) FINAL;
/**
diff --git a/src/components/transport_manager/include/transport_manager/transport_adapter/transport_adapter_listener.h b/src/components/transport_manager/include/transport_manager/transport_adapter/transport_adapter_listener.h
index 3ac664fa29..8cc812fc4d 100644
--- a/src/components/transport_manager/include/transport_manager/transport_adapter/transport_adapter_listener.h
+++ b/src/components/transport_manager/include/transport_manager/transport_adapter/transport_adapter_listener.h
@@ -84,6 +84,11 @@ class TransportAdapterListener {
virtual void OnDeviceListUpdated(
const TransportAdapter* transport_adapter) = 0;
+ /**
+ * @brief OnDeviceAdded is triggered by transport adapter on new device
+ * coming
+ * @param device_uid Device id of new device
+ */
virtual void OnDeviceAdded(DeviceUID device_uid) = 0;
/**
diff --git a/src/components/transport_manager/include/transport_manager/transport_adapter/transport_adapter_listener_impl.h b/src/components/transport_manager/include/transport_manager/transport_adapter/transport_adapter_listener_impl.h
index 5018549b86..4977547f97 100644
--- a/src/components/transport_manager/include/transport_manager/transport_adapter/transport_adapter_listener_impl.h
+++ b/src/components/transport_manager/include/transport_manager/transport_adapter/transport_adapter_listener_impl.h
@@ -85,6 +85,11 @@ class TransportAdapterListenerImpl
*/
virtual void OnDeviceListUpdated(const TransportAdapter* adapter);
+ /**
+ * @brief OnDeviceAdded is triggered by transport adapter on new device
+ * coming and sends ON_DEVICE_ADDED event to transport manager
+ * @param device_uid Device id of new device
+ */
virtual void OnDeviceAdded(DeviceUID device_uid);
virtual void OnFindNewApplicationsRequest(const TransportAdapter* adapter);
diff --git a/src/components/transport_manager/include/transport_manager/transport_manager_impl.h b/src/components/transport_manager/include/transport_manager/transport_manager_impl.h
index ea0392cf0c..4c8e36b745 100644
--- a/src/components/transport_manager/include/transport_manager/transport_manager_impl.h
+++ b/src/components/transport_manager/include/transport_manager/transport_manager_impl.h
@@ -196,8 +196,6 @@ class TransportManagerImpl
void RunAppOnDevice(const DeviceHandle device_handle,
const std::string& bundle_id) OVERRIDE;
- void OnDeviceConnectionSwitched(const DeviceHandle handle) FINAL;
-
/**
* @brief Post event in the event queue.
*
@@ -447,6 +445,18 @@ class TransportManagerImpl
ConnectionInternal* GetActiveConnection(const DeviceUID& device,
const ApplicationHandle& application);
+ /**
+ * @brief TryDeviceSwitch in case USB device is connected and there is
+ * appropriate Bluetooth device with same UUID stops Bluetooth device and
+ * initiates switching sequence for upper layers. Also starts timer to wait
+ * for sequence to complete.
+ * @param ta Transport adapter having device to try switching sequence
+ * @param value Value from device-to-adapter container having all the data
+ * required
+ * At the moment implementation implies only IAP2-Bluetooth to IAP2-USB
+ * switching
+ * @return True if sequence has been successfully initiated, otherwise - false
+ */
bool TryDeviceSwitch(TransportAdapter* ta,
DeviceToAdapterMap::iterator value);
@@ -465,12 +475,22 @@ class TransportManagerImpl
unsigned int frame_size,
unsigned char** frame);
+ /**
+ * @brief OnDeviceAdded processes new device detected by specific transport
+ * adapter
+ * @param ta Pointer to transport adapter
+ */
void OnDeviceAdded(TransportAdapter* ta);
void OnDeviceListUpdated(TransportAdapter* ta);
void DisconnectAllDevices();
void TerminateAllAdapters();
int InitAllAdapters();
static Connection convert(const ConnectionInternal& p);
+
+ /**
+ * @brief ReconnectionTimeout notifies upper layers on switching sequence
+ * timeout expiration
+ */
void ReconnectionTimeout();
/**
@@ -482,4 +502,4 @@ class TransportManagerImpl
void UpdateDeviceMapping(TransportAdapter* ta);
}; // class TransportManagerImpl
} // namespace transport_manager
-#endif // SRC_COMPONENTS_TRANSPORT_MANAGER_INCLUDE_TRANSPORT_MANAGER_TRANSPORT_MANAGER_IMPL_H_ \ No newline at end of file
+#endif // SRC_COMPONENTS_TRANSPORT_MANAGER_INCLUDE_TRANSPORT_MANAGER_TRANSPORT_MANAGER_IMPL_H_