Fast RTPS  Version 2.8.0
Fast RTPS
IPFinder.h
1// Copyright 2016 Proyectos y Sistemas de Mantenimiento SL (eProsima).
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
20#ifndef IPFINDER_H_
21#define IPFINDER_H_
22
23
24
25#include <vector>
26#include <string>
27
28#include <fastdds/rtps/common/Locator.h>
29
30namespace eprosima {
31namespace fastrtps {
32namespace rtps {
38{
39public:
40
41#ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC
45 enum IPTYPE
46 {
51 };
55 typedef struct info_IP
56 {
58 std::string name;
59 std::string dev;
60 Locator_t locator;
62
66 typedef struct info_MAC
67 {
68 unsigned char address[6];
69
71 const info_MAC& other)
72 {
73 return memcmp(address, other.address, 6) == 0;
74 }
75
77
78#endif // ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC
80 virtual ~IPFinder();
81
82 RTPS_DllAPI static bool getIPs(
83 std::vector<info_IP>* vec_name,
84 bool return_loopback = false);
85
90 RTPS_DllAPI static bool getIP4Address(
91 LocatorList_t* locators);
96 RTPS_DllAPI static bool getIP6Address(
97 LocatorList_t* locators);
102 RTPS_DllAPI static bool getAllIPAddress(
103 LocatorList_t* locators);
108 RTPS_DllAPI static bool parseIP4(
109 info_IP& info);
114 RTPS_DllAPI static bool parseIP6(
115 info_IP& info);
116
117 RTPS_DllAPI static std::string getIPv4Address(
118 const std::string& name);
119 RTPS_DllAPI static std::string getIPv6Address(
120 const std::string& name);
121
127 RTPS_DllAPI static bool getAllMACAddress(
128 std::vector<info_MAC>* macs);
129};
130
131} // namespace rtps
132} // namespace fastrtps
133} /* namespace eprosima */
134
135#endif /* IPFINDER_H_ */
Class IPFinder, to determine the IP of the NICs.
Definition: IPFinder.h:38
static RTPS_DllAPI bool getIP6Address(LocatorList_t *locators)
Get the IP6Adresses in all interfaces.
static RTPS_DllAPI std::string getIPv6Address(const std::string &name)
static RTPS_DllAPI bool getAllIPAddress(LocatorList_t *locators)
Get all IP Adresses in all interfaces.
static RTPS_DllAPI bool getIPs(std::vector< info_IP > *vec_name, bool return_loopback=false)
struct eprosima::fastrtps::rtps::IPFinder::info_IP info_IP
Structure info_IP with information about a specific IP obtained from a NIC.
IPTYPE
Enum IPTYPE, to define the type of IP obtained from the NICs.
Definition: IPFinder.h:46
@ IP4_LOCAL
IP4_LOCAL.
Definition: IPFinder.h:49
@ IP4
IP4.
Definition: IPFinder.h:47
@ IP6_LOCAL
IP6_LOCAL.
Definition: IPFinder.h:50
@ IP6
IP6.
Definition: IPFinder.h:48
static RTPS_DllAPI bool parseIP4(info_IP &info)
Parses an IP4 string, populating a info_IP with its value.
struct eprosima::fastrtps::rtps::IPFinder::info_MAC info_MAC
Structure info_MAC with information about a specific MAC obtained from a NIC.
static RTPS_DllAPI std::string getIPv4Address(const std::string &name)
static RTPS_DllAPI bool getIP4Address(LocatorList_t *locators)
Get the IP4Adresses in all interfaces.
static RTPS_DllAPI bool parseIP6(info_IP &info)
Parses an IP6 string, populating a info_IP with its value.
static RTPS_DllAPI bool getAllMACAddress(std::vector< info_MAC > *macs)
Get all MAC Adresses of all interfaces.
eProsima namespace.
Definition: LibrarySettingsAttributes.h:23
Structure info_IP with information about a specific IP obtained from a NIC.
Definition: IPFinder.h:56
std::string dev
Definition: IPFinder.h:59
std::string name
Definition: IPFinder.h:58
IPTYPE type
Definition: IPFinder.h:57
Locator_t locator
Definition: IPFinder.h:60
Structure info_MAC with information about a specific MAC obtained from a NIC.
Definition: IPFinder.h:67
bool operator==(const info_MAC &other)
Definition: IPFinder.h:70
unsigned char address[6]
Definition: IPFinder.h:68