IPOptions.hxx

#pragma once
 
// C++
#include <string>
#include <utility>
 
// cosmos
#include <cosmos/dso_export.h>
#include <cosmos/net/SockOptBase.hxx>
#include <cosmos/utils.hxx>
 
namespace cosmos {
 
// fwd. decl. for friend declarations below
template <SocketFamily family>
class IPSocketT;
 
 
template <OptLevel LEVEL>
class IPOptBase :
                public SockOptBase<LEVEL> {
public: // types
 
 
        enum class MTUDiscoveryMode : int {
                WANT  = IP_PMTUDISC_WANT,
                DONT  = IP_PMTUDISC_DONT,
                DO    = IP_PMTUDISC_DO,
                PROBE = IP_PMTUDISC_PROBE,
        };
 
protected: // functions
 
        using SockOptBase<LEVEL>::SockOptBase;
};
 
 
class COSMOS_API IP4Options :
                public IPOptBase<OptLevel::IP> {
        friend class IPSocketT<SocketFamily::INET>;
public: // types
 
        enum class ToS : uint8_t {
                LOWDELAY    = IPTOS_LOWDELAY,
                THROUGHPUT  = IPTOS_THROUGHPUT,
                RELIABILITY = IPTOS_RELIABILITY,
                MINCOST     = IPTOS_MINCOST
        };
 
public: // functions
 
 
        void setBindAddressNoPort(const bool on_off) {
                setBoolOption(OptName{IP_BIND_ADDRESS_NO_PORT}, on_off);
        }
 
        void setFreeBind(const bool on_off) {
                setBoolOption(OptName{IP_FREEBIND}, on_off);
        }
 
 
        void setHeaderIncluded(const bool on_off) {
                setBoolOption(OptName{IP_HDRINCL}, on_off);
        }
 
 
        void setLocalPortRange(const uint16_t lower_bound, const uint16_t upper_bound);
 
        void resetLocalPortRange() {
                setLocalPortRange(0, 0);
        }
 
 
        std::pair<uint16_t, uint16_t> getLocalPortRange() const;
 
 
        int getMTU() const {
                return getIntOption(OptName{IP_MTU});
        }
 
        MTUDiscoveryMode getMTUDiscoveryMode() const {
                const auto int_mode = getIntOption(OptName{IP_MTU_DISCOVER});
                return MTUDiscoveryMode{int_mode};
        }
 
        void setMTUDiscoveryMode(const MTUDiscoveryMode mode) {
                setIntOption(OptName{IP_MTU_DISCOVER}, to_integral(mode));
        }
 
 
        void setNoDefrag(const bool on_off) {
                setBoolOption(OptName{IP_NODEFRAG}, on_off);
        }
 
        void setPassSecurity(const bool on_off) {
                setBoolOption(OptName{IP_PASSSEC}, on_off);
        }
 
        void setPacketInfo(const bool on_off) {
                setBoolOption(OptName{IP_PKTINFO}, on_off);
        }
 
 
        void setReceiveErrors(const bool on_off) {
                setBoolOption(OptName{IP_RECVERR}, on_off);
        }
 
 
        void setReceiveOptions(const bool on_off) {
                setBoolOption(OptName{IP_RECVOPTS}, on_off);
        }
 
 
        void setReceiveRawOptions(const bool on_off) {
                setBoolOption(OptName{IP_RETOPTS}, on_off);
        }
 
 
        void setReceiveOrigDestAddr(const bool on_off) {
                setBoolOption(OptName{IP_RECVORIGDSTADDR}, on_off);
        }
 
 
        void setReceiveTOS(const bool on_off) {
                setBoolOption(OptName{IP_RECVTOS}, on_off);
        }
 
 
        void setReceiveTTL(const bool on_off) {
                setBoolOption(OptName{IP_RECVTTL}, on_off);
        }
 
 
        void setRouterAlert(const bool on_off) {
                setBoolOption(OptName{IP_ROUTER_ALERT}, on_off);
        }
 
        void setTypeOfService(const ToS tos);
 
        ToS getTypeOfService() const;
 
 
        void setTransparentProxying(const bool on_off) {
                setBoolOption(OptName{IP_TRANSPARENT}, on_off);
        }
 
        void setTimeToLive(const int ttl) {
                setIntOption(OptName{IP_TTL}, ttl);
        }
 
        int getTimeToLive() const {
                return getIntOption(OptName{IP_TTL});
        }
 
        using SockOptBase::getPeerSec;
 
protected: // functions
 
        using IPOptBase::IPOptBase;
};
 
 
class COSMOS_API IP6Options :
                public IPOptBase<OptLevel::IPV6> {
        friend class IPSocketT<SocketFamily::INET6>;
public: // functions
 
 
        void setAddrForm(const SocketFamily family) {
                setIntOption(OptName{IPV6_ADDRFORM}, to_integral(family));
        }
 
 
        int getMTU() const {
                return getIntOption(OptName{IPV6_MTU});
        }
 
        MTUDiscoveryMode getMTUDiscoveryMode() const {
                const auto int_mode = getIntOption(OptName{IPV6_MTU_DISCOVER});
                return MTUDiscoveryMode{int_mode};
        }
 
        void setMTUDiscoveryMode(const MTUDiscoveryMode mode) {
                setIntOption(OptName{IPV6_MTU_DISCOVER}, to_integral(mode));
        }
 
 
        void setMTU(const int mtu) {
                setIntOption(OptName{IPV6_MTU}, mtu);
        }
 
 
        void setReceivePktInfo(const bool on_off) {
                setBoolOption(OptName{IPV6_RECVPKTINFO}, on_off);
        }
 
 
        void setReceiveErrors(const bool on_off) {
                setBoolOption(OptName{IPV6_RECVERR}, on_off);
        }
 
        void setReceiveRoutingHeader(const bool on_off) {
                setBoolOption(OptName{IPV6_RTHDR}, on_off);
        }
 
        void setReceiveAuthHeader(const bool on_off) {
                setBoolOption(OptName{IPV6_AUTHHDR}, on_off);
        }
 
        void setReceiveDestOpts(const bool on_off) {
                setBoolOption(OptName{IPV6_DSTOPTS}, on_off);
        }
 
        void setReceiveHopOpts(const bool on_off) {
                setBoolOption(OptName{IPV6_HOPOPTS}, on_off);
        }
 
 
        void setReceiveHopLimit(const bool on_off) {
                setBoolOption(OptName{IPV6_HOPLIMIT}, on_off);
        }
 
 
        void setRouterAlert(const bool on_off) {
                setBoolOption(OptName{IPV6_ROUTER_ALERT}, on_off);
        }
 
 
        void setUnicastHops(const int hops) {
                setIntOption(OptName{IPV6_UNICAST_HOPS}, hops);
        }
 
 
        void setV6Only(const bool on_off) {
                setBoolOption(OptName{IPV6_V6ONLY}, on_off);
        }
 
protected: // functions
 
        using IPOptBase::IPOptBase;
};
 
}; // end ns