net_if.h

Go to the documentation of this file.

/*
BSD 3-Clause License
 
Copyright (c) 2022, Stable Cloud Computing, Inc.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
 
2. 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.
 
3. Neither the name of the copyright holder 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 _SCC_NET_IF_H
#define _SCC_NET_IF_H
 
#include <vector>
#include <string>
#include <net/inet.h>
 
namespace scc::net {
 
class NetIfAddr : public InetAddr
{
    std::string m_name;
public:
    NetIfAddr(const std::string& name, const InetAddr& addr) : InetAddr(addr), m_name(name) {}
 
    const std::string& if_addr_name() const { return m_name; }
 
    std::string str() const;
};
 
enum NetIfFlag
{
    if_up=              0x001,  
    if_broadcast=       0x002,  
    if_loopback=        0x004,  
    if_pointtopoint=    0x008,  
    if_running=         0x010,  
    if_noarp=           0x020,  
    if_promisc=         0x040,  
    if_allmulti=        0x080,  
    if_multicast=       0x100,  
    if_dynamic=         0x200,  
    if_echo=            0x400   
};
 
class NetIf
{
    std::string m_name;
    std::string m_hwaddr;
    int m_index;
    size_t m_speed;
    size_t m_mtu;
    int m_flags;
    std::vector<NetIfAddr> m_addrs;
 
    static int parse_flags(unsigned);
    static int find_index(const std::string&);
 
    NetIf(const std::string&, const std::string&, int);
    friend class NetIfIterator;
 
public:
    NetIf() {}
 
    static std::vector<NetIf> all_interfaces();
    
    enum class SocketType
    {
        any,
        tcp_stream,
        udp_datagram,
    };
 
    static std::vector<InetAddr> host_addrs(const std::string& name, SocketType=SocketType::any);
 
    const std::string& name() const { return m_name; }
 
    const int index() const { return m_index; }
 
    const std::string& hw_addr() const { return m_hwaddr; }
 
    const size_t speed() const { return m_speed; }
 
    const size_t mtu() const { return m_mtu; }
 
    int flags() const { return m_flags; }
    bool test_flags(int f) const { return (m_flags&f)==f; }
 
    const std::vector<NetIfAddr>& addrs() const { return m_addrs; }
 
    std::string str() const;
};
 
}   // namespace
 
std::ostream& operator<<(std::ostream&, const scc::net::NetIf&);
std::ostream& operator<<(std::ostream&, const scc::net::NetIfAddr&);
 
#endif