networkinterface.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_NETWORK
#include <promeki/namespace.h>
#include <promeki/string.h>
#include <promeki/list.h>
#include <promeki/macaddress.h>
#include <promeki/ipv4address.h>
#include <promeki/ipv6address.h>
#include <promeki/ipv4subnet.h>
#include <promeki/ipv6subnet.h>
#include <promeki/networkinterfaceimpl.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class TextStream;
 
class NetworkInterface {
        public:
                using List = ::promeki::List<NetworkInterface>;
 
                static List enumerate();
 
                static NetworkInterface findByName(const String &name);
 
                static NetworkInterface findByIpv4Address(const Ipv4Address &addr);
 
                static NetworkInterface findByIpv6Address(const Ipv6Address &addr);
 
                static NetworkInterface findByMacAddress(const MacAddress &mac);
 
                static List findRoutesTo(const Ipv4Address &dest);
 
                static List findRoutesTo(const Ipv6Address &dest);
 
                static NetworkInterface firstNonLoopback();
 
                NetworkInterface() = default;
 
                explicit NetworkInterface(NetworkInterfaceImplPtr impl) : _d(std::move(impl)) {}
 
                bool isValid() const { return _d.isValid(); }
 
                NetworkInterfaceData data() const;
 
                String name() const;
 
                String friendlyName() const;
 
                uint32_t index() const;
 
                MacAddress macAddress() const;
 
                MacAddress::List allMacAddresses() const;
 
                Ipv4Subnet::List ipv4Subnets() const;
 
                Ipv6Subnet::List ipv6Subnets() const;
 
                Ipv4Address::List ipv4Addresses() const;
 
                Ipv6Address::List ipv6Addresses() const;
 
                uint32_t mtu() const;
 
                NetworkInterfaceKind kind() const;
 
                uint64_t linkSpeedMbps() const;
 
                bool fullDuplex() const;
 
                bool isUp() const;
 
                bool isRunning() const;
 
                bool hasCarrier() const;
 
                bool isLoopback() const;
 
                bool isMulticast() const;
 
                bool canRoute(const Ipv4Address &dest) const;
 
                bool canRoute(const Ipv6Address &dest) const;
 
                NetworkInterfaceStats stats() const;
 
                String toString() const;
 
                const NetworkInterfaceImplPtr &impl() const { return _d; }
 
                bool operator==(const NetworkInterface &o) const { return _d == o._d; }
                bool operator!=(const NetworkInterface &o) const { return !(*this == o); }
 
        private:
                NetworkInterfaceImplPtr _d;
};
 
TextStream &operator<<(TextStream &stream, const NetworkInterface &iface);
 
PROMEKI_NAMESPACE_END
 
PROMEKI_FORMAT_VIA_TOSTRING(promeki::NetworkInterface);
 
#endif // PROMEKI_ENABLE_NETWORK