summaryrefslogtreecommitdiff
path: root/src/components/include/transport_manager/transport_adapter/transport_adapter_event.h
blob: fd1d693067a2c88700e7a668d22606e1e5421d06 (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
/*
 * 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 SRC_COMPONENTS_INCLUDE_TRANSPORT_MANAGER_TRANSPORT_ADAPTER_TRANSPORT_ADAPTER_EVENT_H_
#define SRC_COMPONENTS_INCLUDE_TRANSPORT_MANAGER_TRANSPORT_ADAPTER_TRANSPORT_ADAPTER_EVENT_H_

#include "transport_manager/common.h"
#include "transport_manager/transport_adapter/transport_adapter.h"
#include "protocol/common.h"

namespace transport_manager {

/**
 * @enum Available types of events.
 */
enum class EventTypeEnum {
  ON_SEARCH_DONE = 0,
  ON_SEARCH_FAIL,
  ON_DEVICE_LIST_UPDATED,
  ON_FIND_NEW_APPLICATIONS_REQUEST,
  ON_CONNECT_DONE,
  ON_CONNECT_FAIL,
  ON_DISCONNECT_DONE,
  ON_DISCONNECT_FAIL,
  ON_SEND_DONE,
  ON_SEND_FAIL,
  ON_RECEIVED_DONE,
  ON_RECEIVED_FAIL,
  ON_COMMUNICATION_ERROR,
  ON_UNEXPECTED_DISCONNECT,
  ON_TRANSPORT_SWITCH_REQUESTED,
  ON_TRANSPORT_CONFIG_UPDATED
};

class TransportAdapterEvent {
 public:
  TransportAdapterEvent() {}
  /**
   * @brief Constructor.
   *
   * @param type Event type.
   * @param transport_adapter Transport adapter
   * @param device_handle Handle of device.
   * @param application_id Handle of application.
   * @param data Smart pointer to the raw message.
   * @param error Error class that contains details of this error situation.
   */
  TransportAdapterEvent(EventTypeEnum type,
                        transport_adapter::TransportAdapter* adapter,
                        const DeviceUID& device_handle,
                        const ApplicationHandle& application_id,
                        ::protocol_handler::RawMessagePtr data,
                        BaseErrorPtr error)
      : event_type(type)
      , application_id(application_id)
      , device_uid(device_handle)
      , transport_adapter(adapter)
      , event_data(data)
      , event_error(error) {}

  /**
   * @brief Value that describe event type.
   */
  EventTypeEnum event_type;
  /**
   * @brief Handle of application
   */
  ApplicationHandle application_id;
  /**
   * @brief  Device unique identifier.
   */
  DeviceUID device_uid;
  /**
   * @brief Transport adapter.
   */
  transport_adapter::TransportAdapter* transport_adapter;
  /**
   * @brief Smart pointer to the raw message
   */
  ::protocol_handler::RawMessagePtr event_data;
  /**
   * @brief Pointer to the class that contain details of error.
   */
  BaseErrorPtr event_error;
};
}  // namespace transport_manager
#endif  // SRC_COMPONENTS_INCLUDE_TRANSPORT_MANAGER_TRANSPORT_ADAPTER_TRANSPORT_ADAPTER_EVENT_H_