summaryrefslogtreecommitdiff
path: root/src/components/include/transport_manager/common.h
blob: 58bcf6bb17e3d5e4e2e972f8b32846c4eae5c131 (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
/*
 * 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_COMMON_H_
#define SRC_COMPONENTS_INCLUDE_TRANSPORT_MANAGER_COMMON_H_

#include <vector>
#include <string>
#include <map>

/**
 * @brief - transport_manager namespace
 */
namespace transport_manager {

/**
 * @enum Transport manager states.
 */
enum {
  E_SUCCESS = 0,
  E_TM_IS_NOT_INITIALIZED,
  E_INVALID_HANDLE,
  E_CONNECTION_IS_TO_SHUTDOWN,
  E_CONNECTION_EXISTS,
  E_ADAPTER_EXISTS,
  E_ADAPTERS_FAIL,
  E_INTERNAL_ERROR
};

/**
 * @brief Type definition for variable that hold handle of device.
 */
typedef size_t DeviceHandle;

/**
 * @brief Type definition for variable that hold connection unique identifier.
 */
typedef unsigned int ConnectionUID;

/**
 * @brief Type definition for variable that hold connection type.
 */
typedef std::string ConnectionType;

/**
 * @brief Type definition for variable that hold device unique identifier.
 */
typedef std::string DeviceUID;

/**
 * @brief Type definition of container(vector) that holds device unique
 * identifiers.
 */
typedef std::vector<DeviceUID> DeviceList;

/**
 * @brief Type definition for variable that hold handle of application.
 */
typedef int ApplicationHandle;

/**
 * @brief Type definition for vector that contain ApplicationHandle variables.
 */
typedef std::vector<ApplicationHandle> ApplicationList;

/**
 * @brief SwitchableDevices defines list of devices having transport switch id
 * i.e. able to switch their transport. Maps unique device id (MAC, serial etc.)
 * to transport switch id (e.g. connection UUID for iAP2 transport)
 */
typedef std::map<DeviceUID, std::string> SwitchableDevices;
}  // namespace transport_manager
#endif  // SRC_COMPONENTS_INCLUDE_TRANSPORT_MANAGER_COMMON_H_