diff options
Diffstat (limited to 'SDL_Core/doc/doxygen/components/TransportManager')
16 files changed, 0 insertions, 549 deletions
diff --git a/SDL_Core/doc/doxygen/components/TransportManager/Client Specification/ConnectionManagement.txt b/SDL_Core/doc/doxygen/components/TransportManager/Client Specification/ConnectionManagement.txt deleted file mode 100644 index 2ba273e9d..000000000 --- a/SDL_Core/doc/doxygen/components/TransportManager/Client Specification/ConnectionManagement.txt +++ /dev/null @@ -1,11 +0,0 @@ -/** @page components_transportmanager_client_connection_management Connection 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. - * To connect remote device client must use NsSmartDeviceLink::NsTransportManager::ITransportManager::connectDevice(). It will initiate connections to all - * applications running on remove device. For TCP device this call has no effect as TCP connections are initiated by remote devices. - * Client will be notified about each connected application with NsSmartDeviceLink::NsTransportManager::ITransportManagerDeviceListener::onApplicationConnected(). - * To disconnect all applications running on remote device client must use NsSmartDeviceLink::NsTransportManager::ITransportManager::disconnectDevice(). - * Client will be notified about each disconnected application with NsSmartDeviceLink::NsTransportManager::ITransportManagerDeviceListener::onApplicationDisconnected(). - */ diff --git a/SDL_Core/doc/doxygen/components/TransportManager/Client Specification/DataTransfer.txt b/SDL_Core/doc/doxygen/components/TransportManager/Client Specification/DataTransfer.txt deleted file mode 100644 index 98dd7426b..000000000 --- a/SDL_Core/doc/doxygen/components/TransportManager/Client Specification/DataTransfer.txt +++ /dev/null @@ -1,11 +0,0 @@ -/** @page components_transportmanager_client_data_transfer Data Transfer - * - * As all requests to TransportManager are asynchronous, client must implement NsSmartDeviceLink::NsTransportManager::ITransportManagerDataListener - * interface and add itself as a data listener with NsSmartDeviceLink::NsTransportManager::ITransportManager::addDataListener() - * in order to receive notifications. - * To send frame to remote device client must use NsSmartDeviceLink::NsTransportManager::ITransportManager::sendFrame() poviding connection handle, - * frame data, data size and user data. User data is an integer that is assigned to a frame and will be sent back to client when sending of frame - * will be completed. Client may use this data to identify frame when send result will be reported. When sending of frame is completed - * client is notified via NsSmartDeviceLink::NsTransportManager::ITransportManagerDataListener::onFrameSendCompleted(). When frame is received from a remote - * device client is notified via NsSmartDeviceLink::NsTransportManager::ITransportManagerDataListener::onFrameReceived(). - */ diff --git a/SDL_Core/doc/doxygen/components/TransportManager/Client Specification/DeviceManagement.txt b/SDL_Core/doc/doxygen/components/TransportManager/Client Specification/DeviceManagement.txt deleted file mode 100644 index eb5f3e477..000000000 --- a/SDL_Core/doc/doxygen/components/TransportManager/Client Specification/DeviceManagement.txt +++ /dev/null @@ -1,14 +0,0 @@ -/** @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. - */ diff --git a/SDL_Core/doc/doxygen/components/TransportManager/Client Specification/index.txt b/SDL_Core/doc/doxygen/components/TransportManager/Client Specification/index.txt deleted file mode 100644 index 8916dbeb5..000000000 --- a/SDL_Core/doc/doxygen/components/TransportManager/Client Specification/index.txt +++ /dev/null @@ -1,18 +0,0 @@ -/*! \page components_transportmanager_client Transport Manager Client Specification - -This chapter describes details of correct use of Transport Manager on the client side. In other words this chapter can be called "How to create effective and safe client of Transport Manager". -Transport Manager defines set of asynchronous requests (means that operations are non-blocking in the calling thread) and provides two different interfaces to monitor asynchronous responses and notifications about data update. - -Clients of Transport Manager should use NsSmartDeviceLink::NsTransportManager::ITransportManager interface to initiate any request to the component. -Also Transport Manager provides two different interfaces: - -1) NsSmartDeviceLink::NsTransportManager::ITransportManagerDataListener. Client can implement this interface if it needs information about data frame send/receive. - -2) NsSmartDeviceLink::NsTransportManager::ITransportManagerDeviceListener. Client can implement this interface if it needs information about updates of devices available for communication and current client applications status. - -For more information about typical use of Transport Manager please read the following topics: - - \subpage components_transportmanager_client_device_management "Device Management" - - \subpage components_transportmanager_client_connection_management "Connection Management" - - \subpage components_transportmanager_client_data_transfer "Data Transfer" - -*/ diff --git a/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/Device Adapters/BluetoothAdapter.txt b/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/Device Adapters/BluetoothAdapter.txt deleted file mode 100644 index 970aeffd8..000000000 --- a/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/Device Adapters/BluetoothAdapter.txt +++ /dev/null @@ -1,19 +0,0 @@ -/** @page components_transportmanager_internal_design_transport_adapters_bluetooth_adapter Bluetooth Adapter - * - * Bluetooth adapter handles communication with external devices via bluetooth. It is implemented in - * NsSmartDeviceLink::NsTransportManager::CBluetoothAdapter. - * - * @section components_transportmanager_internal_design_transport_adapters_bluetooth_adapter_discovery Device discovery - * - * When requested by a call to NsSmartDeviceLink::NsTransportManager::CTransportAdapter::scanForNewDevices() bluetooth adapter - * searches for bluetooth devices. For each found device it runs SDP query for service with SmartDeviceLink UUID - * (936DA01F-9ABD-4D9D-80C7-02AF85C822A8). Devices that support this service are added to bluetooth adapter device list. - * Bluetooth device scans are performed only when explicitly requested. - * - * @section components_transportmanager_internal_design_transport_adapters_bluetooth_adapter_connecting_devices Connecting devices - * - * NsSmartDeviceLink::NsTransportManager::CBluetoothAdapter::createConnectionsListForDevice() runs SDP query for specified device - * and fills connection list with connections to all RFCOMM channels on remote device where SmartDeviceLink service has been discovered. - * - * @see @ref components_transportmanager_internal_design_transport_adapters_common_connecting_devices - */ diff --git a/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/Device Adapters/TCPAdapter.txt b/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/Device Adapters/TCPAdapter.txt deleted file mode 100644 index d81b70dfe..000000000 --- a/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/Device Adapters/TCPAdapter.txt +++ /dev/null @@ -1,20 +0,0 @@ -/** @page components_transportmanager_internal_design_transport_adapters_tcp_adapter TCP Adapter - * - * TCP adapter handles communication with remote devices via TCP/IP socket. It is implemented in - * NsSmartDeviceLink::NsTransportManager::CTCPAdapter. - * - * @section components_transportmanager_internal_design_transport_adapters_tcp_adapter_listen Listening for connections - * - * TCP adapter creates listening TCP socket (TCP port is specified in NsSmartDeviceLink::NsTransportManager::CTCPAdapter::cTCPAdapterPort) - * and listens for incoming connections. Devices are identified by their IP address. - * - * @section components_transportmanager_internal_design_transport_adapters_tcp_adapter_accept Accepting connection - * - * When TCP adapter accepts connection it checks if there is a device with IP address matching with IP address of accepted connection. - * If there is no such device, then this device is added and device list is updated. - * - * @section components_transportmanager_internal_design_transport_adapters_tcp_adapter_disconnecting Disconnecting - * - * When socket gets disconnected TCP adapter checks if there is another opened connection for IP address of disconnected application. - * If it was the last application from this IP address then device with this IP address is removed and devices list is updated. - */ diff --git a/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/Device Adapters/index.txt b/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/Device Adapters/index.txt deleted file mode 100644 index 3a5d0f0e9..000000000 --- a/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/Device Adapters/index.txt +++ /dev/null @@ -1,89 +0,0 @@ -/** @page components_transportmanager_internal_design_transport_adapters Device Adapters - * - * TransportManager communicates with actual devices via device adapters. - * - * @section components_transportmanager_internal_design_transport_adapters_common Common logic - * - * Logic common to all device adapters is implemented in class NsSmartDeviceLink::NsTransportManager::CTransportAdapter. - * - * @subsection components_transportmanager_internal_design_transport_adapters_common_devices_map Devices map - * - * Devices map is a map of device handle to internal device structure NsSmartDeviceLink::NsTransportManager::CTransportAdapter::SDevice. - * Devices map is stored in NsSmartDeviceLink::NsTransportManager::CTransportAdapter::mDevices. Any access to this map must be performed - * with NsSmartDeviceLink::NsTransportManager::CTransportAdapter::mDevicesMutex locked. - * - * @subsection components_transportmanager_internal_design_transport_adapters_common_connections_map Connections map - * - * Connections map is a map of connection handle to internal connection structure NsSmartDeviceLink::NsTransportManager::CTransportAdapter::SConnection. - * Connections map is stored in NsSmartDeviceLink::NsTransportManager::CTransportAdapter::mConnections. Any access to this map must be performed - * with NsSmartDeviceLink::NsTransportManager::CTransportAdapter::mConnectionsMutex locked. - * - * @subsection components_transportmanager_internal_design_transport_adapters_common_main_thread Device adapter main thread - * - * Device adapter main thread is started in NsSmartDeviceLink::NsTransportManager::CTransportAdapter::run(). - * Specific device adapter must implement virtual function NsSmartDeviceLink::NsTransportManager::CTransportAdapter::mainThread() - * and implement its specific main thread logic there. - * - * @subsection components_transportmanager_internal_design_transport_adapters_common_connection_thread Device adapter connection thread - * - * Device adapter connection thread is started in NsSmartDeviceLink::NsTransportManager::CTransportAdapter::startConnection(). - * Specific device adapter must implement virtual function NsSmartDeviceLink::NsTransportManager::CTransportAdapter::connectionThread() - * and implement its specific connection thread logic there. When connection is established and socket file descriptor is set - * in NsSmartDeviceLink::NsTransportManager::CTransportAdapter::SConnection::mConnectionSocket specific device adapter may call - * NsSmartDeviceLink::NsTransportManager::CTransportAdapter::handleCommunication() to handle all communication through this socket - * until connection is terminated. - * - * @subsection components_transportmanager_internal_design_transport_adapters_common_threads_termination Termination of device adapter threads - * - * Specific device adapter implementation must call in its destructor NsSmartDeviceLink::NsTransportManager::CTransportAdapter::waitForThreadsTermination() - * to wait for termination of all threads (main thread and connection threads). Device adapter threads must be terminated before specific - * device adapter class is destructed, so it can't be called in the destructor of base class and must be called explicitly from the inherited - * class's destructor. - * - * @subsection components_transportmanager_internal_design_transport_adapters_common_device_scan Requesting scan for new devices - * - * Device scan is requested by setting flag NsSmartDeviceLink::NsTransportManager::CTransportAdapter::mDeviceScanRequested - * and signaling conditional variable NsSmartDeviceLink::NsTransportManager::CTransportAdapter::mDeviceScanRequestedCond, which may be monitored - * by specific device adapter if it supports device scanning. Specific device adaptere may call for this purpose - * NsSmartDeviceLink::NsTransportManager::CTransportAdapter::waitForDeviceScanRequest() which will wait on this conditional variable - * until it's signaled or specified timeout expires. - * - * @subsection components_transportmanager_internal_design_transport_adapters_common_connecting_devices Connecting devices - * - * Device connection is initiated with a call to NsSmartDeviceLink::NsTransportManager::CTransportAdapter::connectDevice(). - * This method calls virtual function NsSmartDeviceLink::NsTransportManager::CTransportAdapter::createConnectionsListForDevice() - * which may be implemented by specific device adapter to create a list of connections that must be established for the device. - * For each connection created by device adapter it calls NsSmartDeviceLink::NsTransportManager::CTransportAdapter::startConnection() - * which adds connection to connections map and starts connection thread. - * - * @subsection components_transportmanager_internal_design_transport_adapters_common_disconnecting_devices Disconnecting devices - * - * Device disconnection is initiated with a call to NsSmartDeviceLink::NsTransportManager::CTransportAdapter::disconnectDevice(). - * This method finds all connections in connections map that corresponds to specified device and calls - * NsSmartDeviceLink::NsTransportManager::CTransportAdapter::stopConnection() for each of them. - * - * @subsection components_transportmanager_internal_design_transport_adapters_common_handling_communication Handling communication - * - * All frames requested to be sent via NsSmartDeviceLink::NsTransportManager::CTransportAdapter::sendFrame() are stored in - * NsSmartDeviceLink::NsTransportManager::CTransportAdapter::SConnection::mFramesToSend. Pipe - * NsSmartDeviceLink::NsTransportManager::CTransportAdapter::SConnection::mNotificationPipeFds is used by - * NsSmartDeviceLink::NsTransportManager::CTransportAdapter::sendFrame() to notify connection thread that data is available - * to be sent. NsSmartDeviceLink::NsTransportManager::CTransportAdapter::sendFrame() writes one byte to the write end of this pipe. - * NsSmartDeviceLink::NsTransportManager::CTransportAdapter::handleCommunication() uses poll() to wait for - * incoming data using connection socket file descriptor and outgoing data using file descriptor of the read end of this pipe. - * When either of them become available for reading or some error occurs (e.g. socket gets disconnected) connection thread - * wakes up and handles this event. Notification pipe is also used to notify connection thread that connection has to be - * terminated using NsSmartDeviceLink::NsTransportManager::CTransportAdapter::SConnection::mTerminateFlag. - * - * @subsection components_transportmanager_internal_design_transport_adapters_common_update_client_device_list Updating client device list. - * - * Specific device adapter may call NsSmartDeviceLink::NsTransportManager::CTransportAdapter::updateClientDeviceList() when its internal - * knowledge about available devices is updated to notify device adapter client (TransportManager) about this update. - * - * @section components_transportmanager_internal_design_transport_adapters_common_specific Specific device adapters - * - * Current TransportManager implementation contains following device adapters: - * - * - @subpage components_transportmanager_internal_design_transport_adapters_bluetooth_adapter "Bluetooth Adapter" - * - @subpage components_transportmanager_internal_design_transport_adapters_tcp_adapter "TCP Adapter" - */ diff --git a/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/Interaction.txt b/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/Interaction.txt deleted file mode 100644 index 66a798ecb..000000000 --- a/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/Interaction.txt +++ /dev/null @@ -1,7 +0,0 @@ -/*! \page components_transportmanager_internal_design_interaction Sub-Components Interaction - -Internally Transport Manager is a root component for Device Adapters. After running Transport Manager creates Device Adapters and runs them too. - -During system life cycle all messages from Device Adapter are translated via Transport Manager to the clients. In other direction – all requests from clients are re-directed to respective Device Adapters by the Transport Manager. - -*/ diff --git a/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/MultiThreading.txt b/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/MultiThreading.txt deleted file mode 100644 index 6c35f0962..000000000 --- a/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/MultiThreading.txt +++ /dev/null @@ -1,9 +0,0 @@ -/*! \page components_transportmanager_internal_design_multithreading Multi-Threading in Component - -Internally Transport Manager uses different threads for different operations. This design solution was used to provide efficient asynchronous communication with clients and underlying Device Adapters. - -Transport Manager uses one thread to operate with all device-related callbacks. In other word all callbacks declared in NsSmartDeviceLink::NsTransportManager::ITransportManagerDeviceListener will be called from that thread. - -For every active connection one service thread will be created. This thread will be used for all connection-related callbacks. Therefore every implementation of NsSmartDeviceLink::NsTransportManager::ITransportManagerDataListener will be called in separated thread that allows client to support multiple connection simultaneously. - -*/ diff --git a/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/TrasportManager.txt b/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/TrasportManager.txt deleted file mode 100644 index 8c1dd4318..000000000 --- a/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/TrasportManager.txt +++ /dev/null @@ -1,15 +0,0 @@ -/*! \page components_transportmanager_internal_design_trasport_manager Trasport Manager Implementation - -Actually Transport Manager component is implemented as classical manager component. It manages connections and abstract devices and provides unified information for the clients. - -Connection-related information encapsulated in structure NsSmartDeviceLink::NsTransportManager::CTransportManager::SConnectionInfo. Transport Manager manages these structures to store information about every active connection. - -Frame processing encapsulated in structure NsSmartDeviceLink::NsTransportManager::CTransportManager::SFrameDataForConnection. Transport Manager manages these structures to store information related to data for specific connection. - -Callback information between transport manager threads passed in form of special structures: -NsSmartDeviceLink::NsTransportManager::CTransportManager::SDeviceListenerCallback. -NsSmartDeviceLink::NsTransportManager::CTransportManager::SDataListenerCallback. - -Client calls to TM guarded by separate mutex. This allows use component from different threads without any risk. - -*/ diff --git a/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/index.txt b/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/index.txt deleted file mode 100644 index b29ec48dd..000000000 --- a/SDL_Core/doc/doxygen/components/TransportManager/Internal Design/index.txt +++ /dev/null @@ -1,15 +0,0 @@ -/*! \page components_transportmanager_internal_design Component Internal Design - -This chapter is focused on Transport Manager internal design and describes internal sub-components and use of multi-threading. - -Information regarding sub-components is described in following topics: - - \subpage components_transportmanager_internal_design_transport_adapters "Device Adapters" - - \subpage components_transportmanager_internal_design_trasport_manager "Trasport Manager Implementation" - -Detailed description of sub-components interaction is described here: - - \subpage components_transportmanager_internal_design_interaction "Sub-Components Interaction" - -More information about internal usage of multi-threading id described here: - - \subpage components_transportmanager_internal_design_multithreading "Multi-Threading in Component" - -*/ diff --git a/SDL_Core/doc/doxygen/components/TransportManager/Use Cases/UseCase1.txt b/SDL_Core/doc/doxygen/components/TransportManager/Use Cases/UseCase1.txt deleted file mode 100644 index 4af46e432..000000000 --- a/SDL_Core/doc/doxygen/components/TransportManager/Use Cases/UseCase1.txt +++ /dev/null @@ -1,74 +0,0 @@ -/*! \page components_transportmanager_use_cases_1 Scenario with 1 device and 1 application - -<h3>Preconditions:</h3> -<table> - <tr> - <th>Steps</th> - <th>Actions</th> - <th>Expected result</th> - </tr> - <tr> - <td>1</td> - <td>The Device is connected to SmartDeviceLink Core VIA Bluetooth or Wi-Fi</td> - <td> - <p>For BT: Devices are paired</p> - <p>For Wi-Fi: Devices are in the same network</p> - </td> - </tr> - <tr> - <td>2</td> - <td>Make sure that correct device is connected to SmartDeviceLink core</td> - <td>IP-address of connected device is relevant</td> - </tr> -</table> - -<h3>Testcase:</h3> -<table> - <tr> - <th>Steps</th> - <th>Actions</th> - <th>Expected result</th> - </tr> - <tr> - <td>1</td> - <td>Start SmartDeviceLink application on the Devices</td> - <td>SmartDeviceLink application is up and ready</td> - </tr> - <tr> - <td>2</td> - <td>Initiate a Device search in HMI</td> - <td>HMI displays the list of found devices/applications</td> - </tr> - <tr> - <td>3</td> - <td>Connect to desired device\application</td> - <td>Application is marked as connected/notification is displayed in HMI</td> - </tr> - <tr> - <td>4</td> - <td>Send alert message from SmartDeviceLink application</td> - <td>Alert is displayed on HMI</td> - </tr> - <tr> - <td>5</td> - <td>Disconnect device from SmartDeviceLink core</td> - <td>Application is marked as disconnected/notification is displayed in HMI</td> - </tr> - <tr> - <td>6</td> - <td>Try to send alert from disconnected device</td> - <td>Alert shouldn’t be delivered and displayed in HMI</td> - </tr> - <tr> - <td>7</td> - <td><strong>Repeat steps 1-4 with using another connection method (BT of Wi-Fi)</strong></td> - <td>Expected results should be the same</td> - </tr> - <tr> - <td>8</td> - <td><h3>Stress:</h3>Send big amount of alert messages in a short period of time</td> - <td>All alert messages are processed correctly</td> - </tr> -</table> - -*/ diff --git a/SDL_Core/doc/doxygen/components/TransportManager/Use Cases/UseCase2.txt b/SDL_Core/doc/doxygen/components/TransportManager/Use Cases/UseCase2.txt deleted file mode 100644 index de1d6baae..000000000 --- a/SDL_Core/doc/doxygen/components/TransportManager/Use Cases/UseCase2.txt +++ /dev/null @@ -1,96 +0,0 @@ -/*! \page components_transportmanager_use_cases_2 Scenario with 2 or more devices with 1 application onboard - -<h3>Preconditions:</h3> -<table> - <tr> - <th>Steps</th> - <th>Actions</th> - <th>Expected result</th> - </tr> - <tr> - <td>1</td> - <td>Device-1 is connected to Core via Bluetooth</td> - <td>Devices are paired</td> - </tr> - <tr> - <td>2</td> - <td>Device-2 is connected to SmartDeviceLink Core via Wi-Fi</td> - <td>Devices are in the same network</td> - </tr> - <tr> - <td>3</td> - <td>Make sure that correct devices are connected to SmartDeviceLink core</td> - <td>IP-address of connected devices are relevant</td> - </tr> -</table> - -<h3>Testcase:</h3> -<table> - <tr> - <th>Steps</th> - <th>Actions</th> - <th>Expected result</th> - </tr> - <tr> - <td>1</td> - <td>Start SmartDeviceLink application on the Devices</td> - <td>SmartDeviceLink application is up and ready</td> - </tr> - <tr> - <td>2</td> - <td>Initiate a Device search in HMI</td> - <td>HMI displays the list of found devices/applications</td> - </tr> - <tr> - <td>3</td> - <td>Connect to application-1 on 1-st device</td> - <td>Application is marked as connected/notification is displayed in HMI</td> - </tr> - <tr> - <td>4</td> - <td>Connect to application on 2-nd device</td> - <td>Application is marked as connected/notification is displayed in HMI. Both applications on device-1 and device-2 are marked as connected</td> - </tr> - <tr> - <td>5</td> - <td>Send alert message from SmartDeviceLink application-1</td> - <td>Alert is displayed on HMI</td> - </tr> - <tr> - <td>6</td> - <td>Send alert message from SmartDeviceLink application-2</td> - <td>Alert is displayed on HMI</td> - </tr> - <tr> - <td>7</td> - <td>Send alert messages from both application simultaneously</td> - <td>Both alerts are displayed on HMI/Alerts are showed consequently</td> - </tr> - <tr> - <td>8</td> - <td>Disconnect device-2 from SmartDeviceLink core</td> - <td>Application is marked as disconnected/notification is displayed in HMI</td> - </tr> - <tr> - <td>9</td> - <td>Try to send alert messages from both application simultaneously</td> - <td>Alert is delivered only from device-1</td> - </tr> - <tr> - <td>10</td> - <td>Disconnect device-1 from SmartDeviceLink core</td> - <td>Application is marked as disconnected/notification is displayed in HMI</td> - </tr> - <tr> - <td>11</td> - <td><strong>Repeat steps 1-9 with more devices or use same connection method (BT of Wi-Fi)</strong></td> - <td>Expected results should be the same</td> - </tr> - <tr> - <td>12</td> - <td><h3>Stress:</h3>Send big amount of alert messages in a short period of time from all devices</td> - <td>All alert messages are processed correctly</td> - </tr> -</table> - -*/ diff --git a/SDL_Core/doc/doxygen/components/TransportManager/Use Cases/UseCase3.txt b/SDL_Core/doc/doxygen/components/TransportManager/Use Cases/UseCase3.txt deleted file mode 100644 index f11faadfd..000000000 --- a/SDL_Core/doc/doxygen/components/TransportManager/Use Cases/UseCase3.txt +++ /dev/null @@ -1,131 +0,0 @@ -/*! \page components_transportmanager_use_cases_3 Scenario with 2 or more devices with 2 or more applications onboard - -<h3>Preconditions:</h3> -<table> - <tr> - <th>Steps</th> - <th>Actions</th> - <th>Expected result</th> - </tr> - <tr> - <td>1</td> - <td>Device-1 is connected to Core via Bluetooth</td> - <td>Devices are paired</td> - </tr> - <tr> - <td>2</td> - <td>Device-2 is connected to SmartDeviceLink Core via Wi-Fi</td> - <td>Devices are in the same network</td> - </tr> - <tr> - <td>3</td> - <td>Make sure that correct devices are connected to SmartDeviceLink core</td> - <td>IP-address of connected devices are relevant</td> - </tr> -</table> - -<h3>Testcase:</h3> -<table> - <tr> - <th>Steps</th> - <th>Actions</th> - <th>Expected result</th> - </tr> - <tr> - <td>1</td> - <td>Start SmartDeviceLink application on the Devices</td> - <td>SmartDeviceLink application is up and ready</td> - </tr> - <tr> - <td>2</td> - <td>Initiate a Device search in HMI</td> - <td>HMI displays the list of found devices/applications</td> - </tr> - <tr> - <td>3</td> - <td>Connect to application-1 on 1-st device</td> - <td>Application is marked as connected/notification is displayed in HMI</td> - </tr> - <tr> - <td>4</td> - <td>Send alert message from SmartDeviceLink application-1 on device-1</td> - <td>Alert is displayed on HMI</td> - </tr> - <tr> - <td>5</td> - <td>Connect to application-2 on 1-st device</td> - <td>Application is marked as connected/notification is displayed in HMI Both applications are marked as connected</td> - </tr> - <tr> - <td>6</td> - <td>Send alert message from SmartDeviceLink application-2 on device-1</td> - <td>Alert is displayed on HMI</td> - </tr> - <tr> - <td>7</td> - <td>Send alert messages from application-1 and application-2 on device-1 simultaneously</td> - <td>Both alerts are displayed on HMI/Alerts are showed consequently</td> - </tr> - <tr> - <td>8</td> - <td>Connect to application-1 on 2-st device</td> - <td>Application is marked as connected/notification is displayed in HMI. All 3 applications are marked as connected</td> - </tr> - <tr> - <td>9</td> - <td>Send alert messages from application-1 on device-1 and device-2 simultaneously</td> - <td>Both alerts are displayed on HMI/Alerts are showed consequently</td> - </tr> - <tr> - <td>10</td> - <td>Send alert message from SmartDeviceLink application-1 on device-2</td> - <td>Alert is displayed on HMI</td> - </tr> - <tr> - <td>11</td> - <td>Connect to application on 2-nd device</td> - <td>Application is marked as connected/notification is displayed in HMI. All 4 applications are marked as connected</td> - </tr> - <tr> - <td>12</td> - <td>Send alert message from SmartDeviceLink application-2 on device-2</td> - <td>Alert is displayed on HMI</td> - </tr> - <tr> - <td>13</td> - <td>Send alert messages from application-1 and application-2 on device-2 simultaneously</td> - <td>Both alerts are displayed on HMI/Alerts are showed consequently</td> - </tr> - <tr> - <td>14</td> - <td>Send alert messages from application-2 on device-1 and device-2 simultaneously</td> - <td>Both alerts are displayed on HMI/Alerts are showed consequently</td> - </tr> - <tr> - <td>15</td> - <td>Send alert messages from all application simultaneously</td> - <td>Both alerts are displayed on HMI/Alerts are showed consequently</td> - </tr> - <tr> - <td>16</td> - <td>Disconnect device-1 from SmartDeviceLink core</td> - <td>Applications are marked as disconnected/notification is displayed in HMI</td> - </tr> - <tr> - <td>17</td> - <td>Disconnect device-2 from SmartDeviceLink core</td> - <td>All applications are marked as disconnected/notification is displayed in HMI</td> - </tr> - <tr> - <td>18</td> - <td><strong>Repeat steps 1-15 with more devices and more applications or use same connection method (BT of Wi-Fi)</strong></td> - <td>Expected results should be the same</td> - </tr> - <tr> - <td>19</td> - <td><h3>Stress:</h3>Send big amount of alert messages in a short period of time from all devices</td> - <td>All alert messages are processed correctly</td> - </tr> -</table> - -*/ diff --git a/SDL_Core/doc/doxygen/components/TransportManager/Use Cases/index.txt b/SDL_Core/doc/doxygen/components/TransportManager/Use Cases/index.txt deleted file mode 100644 index c929a16a8..000000000 --- a/SDL_Core/doc/doxygen/components/TransportManager/Use Cases/index.txt +++ /dev/null @@ -1,11 +0,0 @@ -/*! \page components_transportmanager_use_cases High-Level Use Cases to Test Component - -This page contains set of high-level use-cases which can be used for testing of Transport Manager functionallity. - -In described scenarious term “Device” means any device which is able to run SmartDeviceLink Applications and capable to connect via BT or -Wi-Fi. - -- \subpage components_transportmanager_use_cases_1 Simple scenario for smoke tests of trasprot level. -- \subpage components_transportmanager_use_cases_2 Many devices verification for transport level operations. -- \subpage components_transportmanager_use_cases_3 Complex verification of correct transport level operations. -*/ diff --git a/SDL_Core/doc/doxygen/components/TransportManager/index.txt b/SDL_Core/doc/doxygen/components/TransportManager/index.txt deleted file mode 100644 index 73252c751..000000000 --- a/SDL_Core/doc/doxygen/components/TransportManager/index.txt +++ /dev/null @@ -1,9 +0,0 @@ -/*! \page components_transportmanager Transport Manager - -Transport Manager is a component of SmartDeviceLink application which is designed to provide transparent access to transport layer for other components. Current implementation provides unified access to connections via Bluetooth and TCP. Also this component allows run automatic device discovery and provides information about found devices which is able to connect to SmartDeviceLink. - -More detailed information is described in following chapters: - - \subpage components_transportmanager_client "Transport Manager Client Specification" - - \subpage components_transportmanager_internal_design "Component Internal Design" - - \subpage components_transportmanager_use_cases "High-Level Use Cases to Test Component" -*/ |