summaryrefslogtreecommitdiff
path: root/src/components/transport_manager/include/transport_manager/iap2_emulation/iap2_transport_adapter.h
blob: e53a472bcb9400aacdbceeaea6c2ec337e440259 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
/*
 * Copyright (c) 2017, 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 SRC_COMPONENTS_TRANSPORT_MANAGER_INCLUDE_TRANSPORT_MANAGER_IAP2_EMULATION_IAP2_TRANSPORT_ADAPTER_H_
#define SRC_COMPONENTS_TRANSPORT_MANAGER_INCLUDE_TRANSPORT_MANAGER_IAP2_EMULATION_IAP2_TRANSPORT_ADAPTER_H_

#include "transport_manager/tcp/tcp_transport_adapter.h"
#include "transport_manager/transport_manager_settings.h"
#include "resumption/last_state.h"
#include "utils/macro.h"
#include "utils/threads/thread_delegate.h"

namespace threads {
class Thread;
}

namespace transport_manager {
namespace transport_adapter {

/**
 * @brief The IAP2BluetoothEmulationTransportAdapter class implements iAP2
 * Bluetooth transport over TCP
 */
class IAP2BluetoothEmulationTransportAdapter : public TcpTransportAdapter {
 public:
  /**
   * @brief IAP2BluetoothEmulationTransportAdapter constructor
   * @param port TCP port to listen on
   * @param last_state LastState instance reference
   * @param settings Settings reference
   */
  IAP2BluetoothEmulationTransportAdapter(
      const uint16_t port,
      resumption::LastState& last_state,
      const TransportManagerSettings& settings);

  /**
   * @brief DeviceSwitched is called during switching from iAP2 Bluetooth to
   * iAP2 USB transport.
   * Currently there is no logic to switch back from iAP2 USB to iAP2 Bluetooth
   * due to Bluetooth reconnection takes much time and this violates some Apple
   * restrictions for iAP2 protocol, so if this method will be called - assert
   * will be called
   * @param device_handle Device handle of switched device
   */
  void DeviceSwitched(const DeviceUID& device_handle) OVERRIDE;

  /**
   * @brief Notification that transport's configuration is updated. This
   * override is needed so that a OnTransportConfigUpdated is not sent to the
   * mobile device for the emulated transport.
   *
   * @param new_config The new configuration of the transport
   */
  void TransportConfigUpdated(const TransportConfig& new_config) OVERRIDE;

 protected:
  /**
   * @brief GetDeviceType Provides SDL device type for transport adapter
   * @return Device type
   */
  DeviceType GetDeviceType() const OVERRIDE;
};

/**
 * @brief The IAP2USBEmulationTransportAdapter class implements emulation of
 * iAP2 USB transport over TCP
 */
class IAP2USBEmulationTransportAdapter : public TcpTransportAdapter {
 public:
  /**
   * @brief IAP2USBEmulationTransportAdapter constructor
   * @param port TCP port to listen on
   * @param last_state LastState instance reference
   * @param settings Settings reference
   */
  IAP2USBEmulationTransportAdapter(const uint16_t port,
                                   resumption::LastState& last_state,
                                   const TransportManagerSettings& settings);

  /**
    * Destructor
    */
  ~IAP2USBEmulationTransportAdapter();

  /**
   * @brief DeviceSwitched is called during switching from iAP2 Bluetooth to
   * iAP2 USB transport. Sends ACK signal for switching request.
   * @param device_handle Device handle of switched device
   */
  void DeviceSwitched(const DeviceUID& device_handle) OVERRIDE;

  /**
   * @brief Notification that transport's configuration is updated. This
   * override is needed so that a OnTransportConfigUpdated is not sent to the
   * mobile device for the emulated transport.
   *
   * @param new_config The new configuration of the transport
   */
  void TransportConfigUpdated(const TransportConfig& new_config) OVERRIDE;

 protected:
  /**
   * @brief GetDeviceType Provides SDL device type for transport adapter
   * @return Device type
   */
  DeviceType GetDeviceType() const OVERRIDE;

 private:
  /**
   * @brief The IAPSignalHandlerDelegate class handles signals from the system
   * to start transport switching flow
   */
  class IAPSignalHandlerDelegate : public threads::ThreadDelegate {
   public:
    /**
     * @brief IAPSignalHandlerDelegate Constructor
     * @param adapter Pointer to iAP2 USB adapter
     */
    IAPSignalHandlerDelegate(IAP2USBEmulationTransportAdapter& adapter);

    /**
     * @brief threadMain Main loop to track incoming signals
     */
    void threadMain() OVERRIDE;

    /**
     * @brief exitThreadMain Stops main loop
     */
    void exitThreadMain() OVERRIDE;

   private:
    /**
     * @brief adapter_ Reference to owning adapter
     */
    IAP2USBEmulationTransportAdapter& adapter_;

    /**
     * @brief run_flag_ Flag defines whether main loop is active
     */
    bool run_flag_;

    /**
     * @brief in_ Input signals channel descriptor
     */
    int in_;
  };

  threads::Thread* signal_handler_;
  int out_;
};
}  // namespace transport_adapter
}  // namespace transport_manager
#endif  // SRC_COMPONENTS_TRANSPORT_MANAGER_INCLUDE_TRANSPORT_MANAGER_IAP2_EMULATION_IAP2_TRANSPORT_ADAPTER_H_