Socket.h

Go to the documentation of this file.

/*
 * Copyright(c) Sophist Solutions, Inc. 1990-2025.  All rights reserved
 */
#ifndef _Stroika_Foundation_IO_Network_Socket_h_
#define _Stroika_Foundation_IO_Network_Socket_h_ 1
 
#include "Stroika/Foundation/StroikaPreComp.h"
 
#include <optional>
 
#if qStroika_Foundation_Common_Platform_POSIX
#include <sys/socket.h>
#endif
 
#include "Stroika/Foundation/Characters/String.h"
#include "Stroika/Foundation/Common/Common.h"
#include "Stroika/Foundation/Debug/AssertExternallySynchronizedMutex.h"
#include "Stroika/Foundation/Execution/Exceptions.h"
#include "Stroika/Foundation/IO/Network/SocketAddress.h"
#if qStroika_Foundation_Common_Platform_Windows
#include "Stroika/Foundation/IO/Network/Platform/Windows/WinSock.h"
#endif
 
#if qStroika_Foundation_Common_Platform_Linux or qStroika_Foundation_Common_Platform_MacOS
using IPPROTO = int;
#endif
 
/**
 *  \file
 *
 *  \note Code-Status:  <a href="Code-Status.md#Beta">Beta</a>
 */
 
namespace Stroika::Foundation::IO::Network {
 
    using Characters::String;
 
    /**
     *  A Socket has two parts, a _IRep*, and a smart pointer wrapper (like shared_ptr <_IRep>).
     *  Users of the class interact only with the smart pointer wrapper.
     *
     *  But for purposes of thread safety, and understanding object lifetime, its important
     *  to consider both.
     *
     *  The Socket class itself is abstract - as you can only create particular kinds of sockets (like connection-oriented etc).
     *
     *  And you almost always just interact with and manage the smart pointers - Socket::Ptr.
     *
     *  But you construct a concrete subtype and assign it to a pointer. 
     *
     *  \par Example Usage
     *      \code
     *          Socket::Ptr      s  = ConnectionlessSocket{ SocketAddress::INET, Socket::DGRAM };
     *      \endcode
     *
     *  The Socket smart pointer objects can be freely assigned and passed around, but the
     *  underlying (_IRep*) socket is finally disposed of when the last reference to it
     *  goes away (or when it is 'Closed').
     *
     *  Closing one, closes them all (though overwriting one just has the effect of detaching
     *  from the underlying socket.
     *
     * TODO:
     *      @todo   In socket class, set CLOSE_ON_EXEC?
     *
     *      @todo   Document (or define new exception) thrown when operation done on CLOSED socket.
     *              and actually handle all the nullptr cases...
     *
     *      @todo   See about socket 'connected' state, and the 'connect' operation.
     *              And see about send/recv() API - and document about only working when
     *              connected.
     *
     *  \note   \em Thread-Safety   not constructable
    */
    namespace Socket {
 
        /**
         *  Platform Socket descriptor - file descriptor on unix (something like this on windoze)
         */
#if qStroika_Foundation_Common_Platform_Windows
        using PlatformNativeHandle = SOCKET;
#else
        using PlatformNativeHandle = int;
#endif
        class _IRep;
 
        /**
         * 'second arg' to ::socket() call - socket type
         */
        enum class Type : int {
            STREAM = SOCK_STREAM,
            DGRAM  = SOCK_DGRAM,
            RAW    = SOCK_RAW,
        };
        using Type::DGRAM;
        using Type::RAW;
        using Type::STREAM;
 
        /**
         */
        struct BindFlags {
            /**
             *  SO_REUSEADDR:
             * 
             *      From https://man7.org/linux/man-pages/man7/socket.7.html
             * 
             *      Indicates that the rules used in validating addresses
             *      supplied in a bind(2) call should allow reuse of local
             *      addresses.  For AF_INET sockets this means that a socket
             *      may bind, except when there is an active listening socket
             *      bound to the address.
             */
            bool fSO_REUSEADDR{false};
        };
 
        /**
         */
        enum class ShutdownTarget {
            eReads,
            eWrites,
            eBoth,
 
            eDEFAULT = eBoth,
 
            Stroika_Define_Enum_Bounds (eReads, eBoth)
        };
 
        /**
         *  \brief a smart pointer wrapper (like shared_ptr <_IRep>).
         *
         *  Users of the class interact only with the smart pointer wrapper.
         *
         *  But for purposes of thread safety, and understanding object lifetime, its important
         *  to consider both.
         *
         *  And you almost always just interact with and manage the smart pointers - Socket::Ptr.
         *
         *  But you construct a concrete subtype and assign it to a pointer. 
         *
         *  \par Example Usage
         *      \code
         *          Socket::Ptr      s  = ConnectionlessSocket{ SocketAddress::INET, Socket::DGRAM };
         *      \endcode
         *
         *  \par Example Usage
         *      \code
         *          Socket::Ptr      s;
         *          if (s == nullptr) {
         *              s = ConnectionlessSocket::New (SocketAddress::INET, Socket::DGRAM);
         *          }
         *      \endcode
         *
         *  The Socket smart pointer objects can be freely assigned and passed around, but the
         *  underlying (_IRep*) socket is finally disposed of when the last reference to it
         *  goes away (or when it is 'Closed').
         *
         *  Closing one, closes them all (though overwriting one just has the effect of detaching
         *  from the underlying socket.
         *
         *  \note   select: Socket has no select method: instead use Execution::WaitForIOReady which
         *          works transparently with sockets, sets of sockets, or other waitable objects.
         *
         *  \note inherits from Socket just for inherited type definitions - no methods or data.
         *
         *  \note <a href="Design-Overview.md#Comparisons">Comparisons</a>:
         *        o static_assert (totally_ordered<Ptr>);
         *        o Socket::Ptr objects are compared (relative or equality) by their underlying 'rep' object.
         *          This USED to be done by calling GetNativeSocket () so two separately attached sockets
         *          would compare equal. Now - we compare the underlying smart pointers. This is nearly always
         *          the same thing, but can be different in the case of multiple objects attached to the same
         *          socket. This is probably a better definition, and definitely more efficient.
         *
         *  \note Since Socket::Ptr is a smart pointer, the constness of the methods depends on whether they modify the smart pointer itself, not
         *        the underlying thread object.
         *
         *  \note   \em Thread-Safety   <a href="Thread-Safety.md#C++-Standard-Thread-Safety-For-Envelope-But-Ambiguous-Thread-Safety-For-Letter">C++-Standard-Thread-Safety-For-Envelope-But-Ambiguous-Thread-Safety-For-Letter</a>
         */
        class Ptr {
        public:
            /**
             *  Socket::Ptr maybe initialized with
             *      o   ConnectionlessSocket::New ()
             *      o   ConnectionOrientedStreamSocket::New ()
             *      o   ConnectionOrientedMasterSocket::New ()
             *
             * \note unless you call @Detach() - socket is CLOSED in DTOR of rep, so when final reference goes away
             */
            Ptr (const Ptr& s)     = default;
            Ptr (Ptr&& s) noexcept = default;
            Ptr (nullptr_t);
 
        protected:
            Ptr () = delete;
            Ptr (shared_ptr<_IRep>&& rep);
            Ptr (const shared_ptr<_IRep>& rep);
 
        public:
            ~Ptr () = default;
 
        public:
            /**
             *  reset () doesn't clear the data in the socket, or close the socket, but un-references the socket
             *  smart pointer. Only if this socket shared_ptr is the last reference to the underlying stream
             *  data does this reset () close the underlying socket.
             *
             *  @see Close ()
             */
            nonvirtual void reset () noexcept;
 
        public:
            /**
             */
            nonvirtual Ptr& operator= (Ptr&& s) noexcept;
            nonvirtual Ptr& operator= (const Ptr& s);
 
        public:
            /**
             *  Disassociate the underlying native socket and this smart ptr. 
             *  If the socket is shared among various smart_ptr reps, this dissociates those as well.
             *
             *  This is legal to call if *this == nullptr.
             *  \post (*this == nullptr)
             *
             *   @see Close ()
             */
            nonvirtual PlatformNativeHandle Detach ();
 
        public:
            /**
             *  Return the first argument to the ::socket() call (address family) or the result of getsockopt (SOL_SOCKET, SO_DOMAIN)
             */
            nonvirtual SocketAddress::FamilyType GetAddressFamily () const;
 
        public:
            /**
             *  Return the second argument to the ::socket() call (type) or the result of getsockopt (SOL_SOCKET, SO_TYPE)
             */
            nonvirtual Type GetType () const;
 
        public:
            /**
             *  Associate this socket object with the given address.
             *
             *  @todo   SB an overload taking just a port, and defaults to INADDRANY with that port.
             *          Port is only thing really needed, but InternetAddress part provided as arg
             *          too in case you want to bind to a particular interface.
             *
             *  @todo   CLARIFY if a socket can be bound to more than one address (and what about unbind)?
             *
             *  \note   This is usually just used on a ConnectionOrientedMasterSocket but may also be used
             *          by a ConnectionlessSocket (e.g. with SSDP).
             *
             *  @see POSIX bind()
             */
            nonvirtual void Bind (const SocketAddress& sockAddr, BindFlags bindFlags = BindFlags{});
 
        public:
            /**
             * if bound (@see Bind ()) - to what local endpoint? Remember a computer can be multi-homed, and can be bound to ADDR_ANY, or a specific address (plus the port).
             */
            nonvirtual optional<IO::Network::SocketAddress> GetLocalAddress () const;
 
        public:
            /**
             *  @see GetAutomaticTCPDisconnectOnClose - if set - Close automatically calls Shutdown () for connection-oriented sockets.
             *
             *  @see https://msdn.microsoft.com/en-us/library/system.net.sockets.socket.shutdown(v=vs.110).aspx
             *      When using a connection-oriented Socket, always call the Shutdown method before closing the Socket.
             *      This ensures that all data is sent and received on the connected socket before it is closed
             *
             *  @see http://pubs.opengroup.org/onlinepubs/9699919799/
             *      The shutdown() function shall cause all or part of a full-duplex connection on the socket
             *      associated with the file descriptor socket to be shut down.
             *
             *      The shutdown() function disables subsequent send and/or receive operations on a socket,
             *      depending on the value of the how argument.
             *
             *  @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms740481(v=vs.85).aspx
             *      If the how parameter is SD_RECEIVE, subsequent calls to the recv function on the socket
             *      will be disallowed. This has no effect on the lower protocol layers. For TCP sockets,
             *      if there is still data queued on the socket waiting to be received, or data arrives subsequently,
             *      the connection is reset, since the data cannot be delivered to the user. For UDP sockets,
             *      incoming datagrams are accepted and queued. In no case will an ICMP error packet be generated.
             *
             *      If the how parameter is SD_SEND, subsequent calls to the send function are disallowed.
             *      For TCP sockets, a FIN will be sent after all data is sent and acknowledged by the receiver.
             * 
             *  \note this is ignored if the socket is already closed.
             */
            nonvirtual void Shutdown (ShutdownTarget shutdownTarget = ShutdownTarget::eDEFAULT);
 
        public:
            /**
             *  Note that Socket::Ptr is an envelope class, and there could be multiple references to
             *  the same underlying platform socket. But this closes ALL of them. It does not
             *  remove the reference to the underlying shared socket rep however.
             *
             *  \note this is safe and does nothing if *this == nullptr, or if the socket is already closed
             *
             *  @see Detach
             *  @see reset ()
             */
            nonvirtual void Close () const;
 
        public:
            /**
             *  A socket can be open or closed. Open is roughly analogous to non-null. A socket once closed
             *  can never be 'Opened' - but you can assign a new Open socket to the Socket object.
             *
             *  \note - not same as ==nullptr? to be open, must not == nullptr and underlying rep must be open.
             *
             *  @see Close
             */
            nonvirtual bool IsOpen () const;
 
        public:
            /**
             */
            nonvirtual bool operator== (const Ptr& rhs) const;
 
        public:
            /**
             */
            nonvirtual strong_ordering operator<=> (const Ptr&) const;
 
        public:
            /**
             *  Return the native platform handle object associated with this socket
             *  (typically an integer file descriptor)
             */
            nonvirtual PlatformNativeHandle GetNativeSocket () const;
 
        public:
            /**
             *  Usually the return value is an int, but the caller must specify the right type. This is a simple,
             *  low level, wrapper on 'man 2 getsockopt'.
             *
             *  \note   this is usually unnecessary, somewhat dangerous (easy to mismatch types), and most common socket options
             *          can be accessed via other methods (e.g. GetMulticastTTL ())
             *
             *  @see setsockopt
             */
            template <typename RESULT_TYPE>
            nonvirtual RESULT_TYPE getsockopt (int level, int optname) const;
 
        public:
            /**
             *  This is a simple, low level, wrapper on 'man 2 setsockopt'.
             *
             *  \note   this is usually unnecessary, somewhat dangerous (easy to mismatch types), and most common socket options
             *          can be accessed via other methods (e.g. SetMulticastTTL ())
             *
             *  \note   It maybe advisable to be explicit about the ARG_TYPE in the template, as constants like '3' may get misinterpreted,
             *          and you must use the exactly correct type for the low level setsockopt API.
             *
             *  @see getsockopt
             */
            template <typename ARG_TYPE>
            nonvirtual void setsockopt (int level, int optname, ARG_TYPE arg) const;
 
        public:
            /**
             *  @see Characters::ToString ()
             */
            nonvirtual String ToString () const;
 
        protected:
            /**
             */
            nonvirtual shared_ptr<_IRep> _GetSharedRep () const;
 
        protected:
            /**
             * \pre fRep_ != nullptr
             */
            nonvirtual _IRep& _ref () const;
 
        protected:
            /**
             * \pre fRep_ != nullptr
             */
            nonvirtual const _IRep& _cref () const;
 
        protected:
            [[no_unique_address]] Debug::AssertExternallySynchronizedMutex _fThisAssertExternallySynchronized;
 
        private:
            shared_ptr<_IRep> fRep_;
        };
        static_assert (totally_ordered<Ptr>);
 
        /**
         */
        class _IRep {
        public:
            virtual ~_IRep ()                                                                     = default;
            virtual void                                 Shutdown (ShutdownTarget shutdownTarget) = 0;
            virtual void                                 Close ()                                 = 0;
            virtual PlatformNativeHandle                 Detach ()                                = 0;
            virtual optional<IO::Network::SocketAddress> GetLocalAddress () const                 = 0;
            virtual SocketAddress::FamilyType            GetAddressFamily () const                = 0;
            virtual PlatformNativeHandle                 GetNativeSocket () const                 = 0;
            virtual void                                 getsockopt (int level, int optname, void* optval, socklen_t* optvallen) const = 0;
            virtual void                                 setsockopt (int level, int optname, const void* optval, socklen_t optvallen)  = 0;
        };
 
        namespace _Protected {
            PlatformNativeHandle mkLowLevelSocket_ (SocketAddress::FamilyType family, Socket::Type socketKind, const optional<IPPROTO>& protocol);
            tuple<PlatformNativeHandle, PlatformNativeHandle> mkLowLevelSocketPair_ (SocketAddress::FamilyType family, Socket::Type socketKind,
                                                                                     const optional<IPPROTO>& protocol);
        }
    };
 
#if qStroika_Foundation_Common_Platform_Windows
    /**
     * If the argument value (return code from some WSA API call) is SOCKET_ERROR (or if T = SOCKET we check for INVALID_SOCKET)
     * This function throws a system error code given by WSAGetLastError ()
     *
     * see docs for https://docs.microsoft.com/en-us/windows/desktop/api/winsock2/nf-winsock2-accept
     * or https://docs.microsoft.com/en-us/windows/desktop/api/winsock/nf-winsock-bind
     * for examples of functions this can be used to wrap.
     */
    template <typename INT_TYPE>
    INT_TYPE ThrowWSASystemErrorIfSOCKET_ERROR (INT_TYPE returnCode)
        requires (is_signed_v<INT_TYPE>);
    IO::Network::Socket::PlatformNativeHandle ThrowWSASystemErrorIfSOCKET_ERROR (IO::Network::Socket::PlatformNativeHandle returnCode);
#endif
 
}
 
namespace Stroika::Foundation::Execution::WaitForIOReady_Support {
 
    // Specialize to override GetSDKPollable
    template <typename T>
    struct WaitForIOReady_Traits;
    template <>
    struct WaitForIOReady_Traits<IO::Network::Socket::Ptr> {
        using HighLevelType = IO::Network::Socket::Ptr;
        static inline auto GetSDKPollable (const HighLevelType& t)
        {
            return t.GetNativeSocket ();
        }
    };
 
}
 
/*
 ********************************************************************************
 ***************************** Implementation Details ***************************
 ********************************************************************************
 */
#include "Socket.inl"
 
#endif /*_Stroika_Foundation_IO_Network_Socket_h_*/