SocketOptions.hpp

Go to the documentation of this file.

 
#pragma once
 
#include "common.hpp"
 
namespace jsocketpp
{

class SocketOptions
{
  public:
    SocketOptions() = delete;

    explicit SocketOptions(const SOCKET sock) noexcept : _sockFd(sock) {}

    virtual ~SocketOptions() = default;

    SocketOptions(const SocketOptions&) = delete;

    SocketOptions(SocketOptions&&) noexcept = default;

    SocketOptions& operator=(const SocketOptions&) = delete;

    SocketOptions& operator=(SocketOptions&&) noexcept = default;

    [[nodiscard]] SOCKET getSocketFd() const noexcept { return _sockFd; }

    void setOption(int level, int optName, int value);

    void setOption(int level, int optName, const void* value, socklen_t len);

    [[nodiscard]] int getOption(int level, int optName) const;

    void getOption(int level, int optName, void* result, socklen_t* len) const;

    void setReuseAddress(bool on);

    [[nodiscard]] bool getReuseAddress() const;

    void setReceiveBufferSize(std::size_t size);

    [[nodiscard]] int getReceiveBufferSize() const;

    void setSendBufferSize(std::size_t size);

    [[nodiscard]] int getSendBufferSize() const;

    void setSoLinger(bool enable, int seconds);

    [[nodiscard]] std::pair<bool, int> getSoLinger() const;

    void setKeepAlive(bool on);

    [[nodiscard]] bool getKeepAlive() const;

    void setSoRecvTimeout(int millis);

    void setSoSendTimeout(int millis);

    [[nodiscard]] int getSoRecvTimeout() const;

    [[nodiscard]] int getSoSendTimeout() const;

    void setNonBlocking(bool nonBlocking);

    [[nodiscard]] bool getNonBlocking() const;

    void setTcpNoDelay(bool on);

    [[nodiscard]] bool getTcpNoDelay() const;

    void setBroadcast(bool on);

    [[nodiscard]] bool getBroadcast() const;
 
#if defined(IPV6_V6ONLY)

    void setIPv6Only(bool enable);

    [[nodiscard]] bool getIPv6Only() const;
 
#endif
 
#if defined(SO_REUSEPORT)

    void setReusePort(const bool enable);

    [[nodiscard]] bool getReusePort() const;
 
#endif

    void setMulticastTTL(int ttl);

    [[nodiscard]] int getMulticastTTL() const;

    void setMulticastLoopback(bool enable);

    [[nodiscard]] bool getMulticastLoopback() const;

    void setMulticastInterfaceIPv4(in_addr addr);

    void setMulticastInterfaceIPv6(unsigned int ifindex);

    void joinGroupIPv4(in_addr group, in_addr iface);

    void leaveGroupIPv4(in_addr group, in_addr iface);

    void joinGroupIPv6(in6_addr group, unsigned int ifindex);

    void leaveGroupIPv6(in6_addr group, unsigned int ifindex);
 
  protected:
    void setSocketFd(const SOCKET sock) noexcept { _sockFd = sock; }

    [[nodiscard]] virtual bool isPassiveSocket() const noexcept { return false; }

    static bool is_ipv4_multicast(const in_addr v4) { return IN_MULTICAST(ntohl(v4.s_addr)) != 0; }

    static bool is_ipv6_multicast(const in6_addr& v6) { return IN6_IS_ADDR_MULTICAST(&v6) != 0; }

    static [[nodiscard]] int detectFamily(SOCKET fd);
 
  private:
    SOCKET _sockFd = INVALID_SOCKET; 
};
 
} // namespace jsocketpp