summaryrefslogtreecommitdiff
path: root/SDL_Core/src/components/connection_handler/include/connection_handler/device.h
blob: b480aeb994d4d719542b963f96c363aa71168e0a (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
/**
 * \file Device.hpp
 * \brief Device class.
 * Stores device information
 *
 * 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_CONNECTION_HANDLER_INCLUDE_CONNECTION_HANDLER_DEVICE_H_
#define SRC_COMPONENTS_CONNECTION_HANDLER_INCLUDE_CONNECTION_HANDLER_DEVICE_H_

#include <string>
#include <map>
#include <vector>
#include "utils/logger.h"

/**
 * \namespace connection_handler
 * \brief SmartDeviceLink connection_handler namespace.
 */
namespace connection_handler {

/**
 * \brief Type for DeviceHandle
 */
typedef uint32_t DeviceHandle;
typedef std::vector<int32_t> AppList;

/**
 * \class Device
 * \brief Connection class
 */
class Device {
  public:
    /**
     * \brief Class constructor
     */
    Device(DeviceHandle device_handle, const std::string& user_friendly_name,
           const std::string& mac_address = "");

    /**
     * \brief Destructor
     */
    ~Device();

    /**
     * \brief Returns device handle
     * \return DeviceHandle
     */
    DeviceHandle device_handle() const;

    /**
     * \brief Returns user frendly device name
     * \return UserFriendlyName
     */
    std::string user_friendly_name() const;

    std::string mac_address() const;

  private:
    /**
     * \brief Uniq device handle.
     */
    DeviceHandle device_handle_;

    /**
     * \brief User-friendly device name.
     */
    std::string user_friendly_name_;

    /**
     * \brief Mac address of device if available
     */
    std::string mac_address_;

    /**
     * \brief For logging.
     */
    static log4cxx::LoggerPtr logger_;
};

/**
 * \brief Type for Devices map
 */
typedef std::map<int32_t, Device> DeviceList;

/**
 * \brief Type for Devices map iterator
 * Key is DeviceHandle which is uniq
 */
typedef std::map<int32_t, Device>::iterator DeviceListIterator;

}/* namespace connection_handler */

#endif  // SRC_COMPONENTS_CONNECTION_HANDLER_INCLUDE_CONNECTION_HANDLER_DEVICE_H_