diff options
Diffstat (limited to 'src/components/policy/policy_external/doc/doxygen/components/TransportManager/Client Specification/DataTransfer.txt')
| -rw-r--r-- | src/components/policy/policy_external/doc/doxygen/components/TransportManager/Client Specification/DataTransfer.txt | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/src/components/policy/policy_external/doc/doxygen/components/TransportManager/Client Specification/DataTransfer.txt b/src/components/policy/policy_external/doc/doxygen/components/TransportManager/Client Specification/DataTransfer.txt new file mode 100644 index 0000000000..98dd7426be --- /dev/null +++ b/src/components/policy/policy_external/doc/doxygen/components/TransportManager/Client Specification/DataTransfer.txt @@ -0,0 +1,11 @@ +/** @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(). + */ |