modularization/thirdpartylib/FastRTPS/include/fastrtps/utils/IPFinder.h

// Copyright 2016 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
 * @file IPFinder.h
 *
 */

#ifndef IPFINDER_H_
#define IPFINDER_H_



#include <vector>
#include <string>

#include <fastdds/rtps/common/Locator.h>

namespace eprosima {
namespace fastrtps {
namespace rtps {
/**
 * Class IPFinder, to determine the IP of the NICs.
 * @ingroup UTILITIES_MODULE
 */
class IPFinder
{
    public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC
        /**
         * Enum IPTYPE, to define the type of IP obtained from the NICs.
         */
        enum IPTYPE
        {
            IP4,      //!< IP4
            IP6,      //!< IP6
            IP4_LOCAL,//!< IP4_LOCAL
            IP6_LOCAL //!< IP6_LOCAL
        };
        /**
         * Structure info_IP with information about a specific IP obtained from a NIC.
         */
        typedef struct info_IP
        {
            IPTYPE type;
            std::string name;
            std::string dev;
            Locator_t locator;
        }info_IP;
#endif
        IPFinder();
        virtual ~IPFinder();

        RTPS_DllAPI static bool getIPs(std::vector<info_IP>* vec_name, bool return_loopback = false);

        /**
         * Get the IP4Adresses in all interfaces.
         * @param[out] locators List of locators to be populated with the IP4 addresses.
         */
        RTPS_DllAPI static bool getIP4Address(LocatorList_t* locators);
        /**
         * Get the IP6Adresses in all interfaces.
         * @param[out] locators List of locators to be populated with the IP6 addresses.
         */
        RTPS_DllAPI static bool getIP6Address(LocatorList_t* locators);
        /**
         * Get all IP Adresses in all interfaces.
         * @param[out] locators List of locators to be populated with the addresses.
         */
        RTPS_DllAPI static bool getAllIPAddress(LocatorList_t* locators);
        /**
         * Parses an IP4 string, populating a info_IP with its value.
         * @param[out] info info_IP to populate.
         * */
        RTPS_DllAPI static bool parseIP4(info_IP& info);
        /**
         * Parses an IP6 string, populating a info_IP with its value.
         * @param[out] info info_IP to populate.
         * */
        RTPS_DllAPI static bool parseIP6(info_IP& info);

        RTPS_DllAPI static std::string getIPv4Address(const std::string &name);
        RTPS_DllAPI static std::string getIPv6Address(const std::string &name);
};

}
}
} /* namespace eprosima */

#endif /* IPFINDER_H_ */