diff options
Diffstat (limited to 'SDL_Core/src/components/TransportManager/src/IDeviceAdapterListener.hpp')
-rw-r--r-- | SDL_Core/src/components/TransportManager/src/IDeviceAdapterListener.hpp | 126 |
1 files changed, 126 insertions, 0 deletions
diff --git a/SDL_Core/src/components/TransportManager/src/IDeviceAdapterListener.hpp b/SDL_Core/src/components/TransportManager/src/IDeviceAdapterListener.hpp new file mode 100644 index 000000000..be16bc847 --- /dev/null +++ b/SDL_Core/src/components/TransportManager/src/IDeviceAdapterListener.hpp @@ -0,0 +1,126 @@ +/** + * \file IDeviceAdapterListener.hpp + * \brief Class IDeviceAdapterListener. + * Copyright (c) 2013, Ford Motor Company + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * + * Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following + * disclaimer in the documentation and/or other materials provided with the + * distribution. + * + * Neither the name of the Ford Motor Company nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef __TRANSPORTMANAGER_IDEVICEADAPTERLISTENER_HPP__ +#define __TRANSPORTMANAGER_IDEVICEADAPTERLISTENER_HPP__ + +#include <stdint.h> +#include <sys/types.h> +#include <vector> + +#include "TransportManager/ITransportManager.hpp" +#include "TransportManager/ITransportManagerDataListener.hpp" +#include "TransportManager/ITransportManagerDeviceListener.hpp" + +#include "SInternalDeviceInfo.hpp" + +namespace NsSmartDeviceLink +{ + namespace NsTransportManager + { + class IDeviceAdapter; + + /** + * @brief Interface of device adapter listener. + * + * Used to notify transport manager about events in + * device adapters. + * @interface IDeviceAdapterListener + **/ + class IDeviceAdapterListener + { + public: + /** + * @brief Destructor. + **/ + virtual ~IDeviceAdapterListener(void); + + /** + * @brief Available devices list updated callback. + * + * Called when device scanning initiated with scanForNewDevices + * is completed. + * + * @param DeviceAdapter Calling device adapter. + * @param DeviceList New list of available devices. + **/ + virtual void onDeviceListUpdated(IDeviceAdapter * DeviceAdapter, const tInternalDeviceList & DeviceList); + + /** + * @brief Application connected callback. + * + * @param DeviceAdapter Device adapter + * @param ConnectedDevice DeviceInfo of device with connected application. + * @param Connection Connection handle. + **/ + virtual void onApplicationConnected(IDeviceAdapter * DeviceAdapter, const SDeviceInfo & ConnectedDevice, const tConnectionHandle ConnectionHandle); + + /** + * @brief Application disconnected callback. + * + * @param DeviceAdapter Device adapter + * @param ConnectedDevice DeviceInfo of device with connected application. + * @param Connection Connection handle. + **/ + virtual void onApplicationDisconnected(IDeviceAdapter * DeviceAdapter, const SDeviceInfo & DisconnectedDevice, const tConnectionHandle ConnectionHandle); + + /** + * @brief Frame received callback. + * + * @param DeviceAdapter Calling device adapter. + * @param ConnectionHandle Connection handle. + * @param Data Received frame data. + * @param DataSize Size of received data in bytes. + * + * @note %Data pointed by parameter Data is valid only until + * this callback returns control to the caller. Callback + * handler is responsible to copy this data to its own + * location if it needs the data after return. + **/ + virtual void onFrameReceived(IDeviceAdapter * DeviceAdapter, tConnectionHandle ConnectionHandle, const uint8_t * Data, size_t DataSize); + + /** + * @brief Frame send completed callback. + * + * @param DeviceAdapter Calling device adapter. + * @param ConnectionHandle Connection handle. + * @param FrameSequenceNumber Sequence numbere of frame that was previously returned by ITransportManager::sendFrame. + * @param SendStatus Result status. + **/ + virtual void onFrameSendCompleted(IDeviceAdapter * DeviceAdapter, tConnectionHandle ConnectionHandle, int FrameSequenceNumber, ESendStatus SendStatus); + }; + } +} + +#endif |