socket.hpp

Go to the documentation of this file.

#ifndef UPnPsdk_SOCKET_HPP
#define UPnPsdk_SOCKET_HPP
// Copyright (C) 2023+ GPL 3 and higher by Ingo Höft, <Ingo@Hoeft-online.de>
// Redistribution only with this Copyright remark. Last modified: 2025-05-19
#include <UPnPsdk/sockaddr.hpp>
#include <UPnPsdk/synclog.hpp>
#include <mutex>
#include <memory>
 
// To be portable with BSD socket error number constants I have to
// define and use these macros with appended 'P' for portable.
#ifdef _MSC_VER
#define EBADFP WSAENOTSOCK
#define ENOTCONNP WSAENOTCONN
#define EINTRP WSAEINTR
#define EFAULTP WSAEFAULT
#define ENOMEMP WSA_NOT_ENOUGH_MEMORY
#define EINVALP WSAEINVAL
#define EACCESP WSAEACCES
#define ENOBUFSP WSAENOBUFS
#else
#define EBADFP EBADF
#define ENOTCONNP ENOTCONN
#define EINTRP EINTR
#define EFAULTP EFAULT
#define ENOMEMP ENOMEM
#define EINVALP EINVAL
#define EACCESP EACCES
#define ENOBUFSP ENOBUFS
#endif
 
namespace UPnPsdk {
 
class UPnPsdk_API CSocket_basic {
  public:
    CSocket_basic();
 
    CSocket_basic(SOCKET a_sfd) ;
 
    // I want to restrict to only move the resource.
    // No copy constructor
    CSocket_basic(const CSocket_basic&) = delete;
    // No copy assignment operator
    CSocket_basic& operator=(CSocket_basic) = delete;
 
    // Destructor
    virtual ~CSocket_basic();
 
 
    void load();
 
 
    operator SOCKET() const;
 
 
    bool local_saddr(
        SSockaddr* a_saddr = nullptr) const;
 
 
    bool remote_saddr(
        SSockaddr* a_saddr = nullptr) const;
 
 
    int socktype() const;
 
    int sockerr() const;
 
    bool is_reuse_addr() const;
 
  protected:
    // This is the raw socket file descriptor
    SOCKET m_sfd{INVALID_SOCKET};
 
    // Mutex to protect socket object.
    mutable ::pthread_mutex_t m_socket_mutex = PTHREAD_MUTEX_INITIALIZER;
 
    // CSocket_basic::local_saddr() without pthread mutex lock/unlock for
    // 'protected:' use only.
    bool local_saddr_protected(SSockaddr* a_saddr) const;
 
  private:
    // Hint from the constructor what socket file descriptor to use.
    const SOCKET m_sfd_hint{INVALID_SOCKET};
};
 
 
class UPnPsdk_API CSocket : public CSocket_basic {
  public:
    CSocket();
 
    CSocket(CSocket&&);
 
    CSocket& operator=(CSocket);
 
    virtual ~CSocket();
 
    void bind(
        const int a_socktype,
        const SSockaddr* const a_saddr = nullptr,
        const int a_flags = 0);
 
    void listen();
 
 
    bool is_listen() const;
 
  private:
    bool m_listen{false};
};
 
 
// Portable handling of socket errors
// ==================================
class UPnPsdk_API CSocketErr {
  public:
    CSocketErr();
    ~CSocketErr();
    // Delete copy constructor
    CSocketErr(const CSocketErr&) = delete;
    // Delete assignment operator
    CSocketErr& operator=(const CSocketErr&) = delete;
    operator const int&();
    void catch_error();
    std::string error_str() const;
 
  private:
    int m_errno{}; // Cached error number
};
 
} // namespace UPnPsdk
 
#endif // UPnPsdk_SOCKET_HPP