ISocketService.hpp

 
//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Ve/IServiceObject.hpp"
 
namespace Arp { namespace System { namespace Ve
{
class ISocketService : public virtual IServiceObject
{
public: //typedefs
    enum class SocketType
    {
        None = 0,
        Tcp  = 1,
        Udp  = 2
    };
 
    enum class SocketDomain
    {
        None = 0,
        Ipv4 = 1,
        Ipv6 = 2,
        Local
    };
 
    enum class SocketBlockingMode
    {
        None          = 0,
        Blocking      = 1,
        NoneBlocking  = 2
    };
 
    enum class SelectMode
    {
        SelectRead    = 0,
        SelectWrite   = 1,
        SelectConnect = 3,
        SelectAccept  = 4
    };
 
    enum class PollMode
    {
        None = 0,
        Read = 1,
        Write = 2,
        Connect = 3,
        Accept = 4
    };
 
    enum class ShutdownMode
    {
        Read = 0,       
        Write = 1,      
        ReadWrite = 2,  
    };
 
    enum class SocketOptionName
    {
        SocketOptionReuseAddress = 0x0004,
 
        SocketOptionKeepAlive = 0x0008,
 
        SocketOptionBroadcast = 0x0020,
 
        SocketOptionLinger = 0x0080,
 
        SocketOptionReceiveTimeout = 0x0200,
 
        SocketOptionSendTimeout = 0x0800,
 
        SocketOptionNoDelay = 1,
 
        SocketOptionPeerCredentials = 2,
 
        SocketOptionUserTimeout = 100,
 
        SocketOptionKeepAliveIdleTime = 101,
 
        SocketOptionKeepAliveProbeInterval = 102,
 
        SocketOptionKeepAliveProbeCount = 103,
    };
 
 
    //error codes for socket from eclr
    enum class SocketError
    {
        Success = 0,
        Unspecified = -1,
        Interrupted = (10000 + 4),                  //WSAEINTR
        InvalidArgument = (10000 + 22),             //WSAEINVAL
        TooManyOpenSockets = (10000 + 24),          //WSAEMFILE
        WouldBlock = (10000 + 35),                  //WSAEWOULDBLOCK
        InProgress = (10000 + 36),                  //WSAEINPROGRESS
        AlreadyInProgress = (10000 + 37),           //WSAEALREADY
        NotSocket = (10000 + 38),                   //WSAENOTSOCK
        DestinationAddressRequired = (10000 + 39),  //WSAEDESTADDRREQ
        MessageSize = (10000 + 40),                 //WSAEMSGSIZE
        ProtoType = (10000 + 41),                   //WSAEPROTOTYPE
        ProtocolOption = (10000 + 42),              //WSAENOPROTOOPT
        ProtocolNotSupported = (10000 + 43),        //WSAEPROTONOSUPPORT
        SocketNotSupported = (10000 + 44),          //WSAESOCKTNOSUPPORT
        OperationNotSupported = (10000 + 45),       //WSAEOPNOTSUPP
        ProtocolFamilyNotSupported = (10000 + 46),  //WSAEPFNOSUPPORT
        AddressFamilyNotSupported = (10000 + 47),   //WSAEAFNOSUPPORT
        AddressAlreadyInUse = (10000 + 48),         //WSAEADDRINUSE
        AddressNotAvailable = (10000 + 49),         //WSAEADDRNOTAVAIL
        NetworkDown = (10000 + 50),                 //WSAENETDOWN
        NetworkUnreachable = (10000 + 51),          //WSAENETUNREACH
        NetworkReset = (10000 + 52),                //WSAENETRESET
        ConnectionAborted = (10000 + 53),           //WSAECONNABORTED
        ConnectionReset = (10000 + 54),             //WSAECONNRESET
        NoBufferSpaceAvailable = (10000 + 55),      //WSAENOBUFS
        IsConnected = (10000 + 56),                 //WSAEISCONN
        NotConnected = (10000 + 57),                //WSAENOTCONN
        Shutdown = (10000 + 58),                    //WSAESHUTDOWN
        TimedOut = (10000 + 60),                    //WSAETIMEDOUT
        ConnectionRefused = (10000 + 61),           //WSAECONNREFUSED
        HostDown = (10000 + 64),                    //WSAEHOSTDOWN
        HostUnreachable = (10000 + 65),             //WSAEHOSTUNREACH
        ProcessLimit = (10000 + 67),                //WSAEPROCLIM
        SystemNotReady = (10000 + 91),              //WSASYSNOTREADY
        VersionNotSupported = (10000 + 92),         //WSAVERNOTSUPPORTED
        NotInitialized = (10000 + 93),              //WSANOTINITIALISED
        Disconnecting = (10000 + 101),              //WSAEDISCON
        HostNotFound = (10000 + 1001),              //WSAHOST_NOT_FOUND
        TryAgain = (10000 + 1002)                   //WSATRY_AGAIN
    };
 
    struct PeerCredentials
    {
        int uid = -1;
        int gid = -1;
        int pid = -1;
    };
 
public:  // methods
    virtual SocketError Bind(uint32 ip4Address, int& port) = 0;
    virtual SocketError Bind(const String& path) = 0;
    virtual ISocketService* Accept(uint32& ip4Address, int& port, SocketError& error) = 0;
    virtual ISocketService* Accept(String& path, SocketError& error) = 0;
    virtual SocketError Connect(uint32 ip4Address, int port) = 0;
    virtual SocketError Connect(const String& path) = 0;
    virtual SocketError Listen(int backlog) = 0;
    virtual SocketError SetSockOpt(SocketOptionName optionName, const void* optionValue, size_t optionLength) = 0;
    virtual SocketError GetSockOpt(SocketOptionName optionName, void* optionValue, size_t *optionLength) = 0;
    virtual int Select(SelectMode mode, size_t timeout_us, SocketError& error) = 0;
    virtual int Poll(PollMode mode, size_t timeoutMillis, SocketError& error) = 0;
    virtual SocketError Close(void) = 0;
    virtual SocketError Shutdown(void) = 0;
    virtual SocketError Shutdown(ShutdownMode mode) = 0;
    virtual int Send(const void* pBuffer, size_t len, SocketError& error) = 0;
    virtual int SendTo(const void* pBuffer, size_t len, SocketError& error, uint32 ip4Address, int port) = 0;
    virtual int Recv(void* pBuffer, size_t len, SocketError& error) = 0;
    virtual int RecvFrom(void* pBuffer, size_t len, SocketError& error, uint32& ip4Address, int& port) = 0;
    virtual SocketError SetOptionBlocking(bool enable) = 0;
 
    virtual SocketError SetOptionLinger(bool enable, size_t timeout) = 0;
    virtual SocketError GetOptionLinger(bool& enable, size_t& timeout) = 0;
 
    virtual SocketError SetOptionUserTimeout(size_t timeout_ms) = 0;
    virtual SocketError GetOptionUserTimeout(size_t& timeout_ms) = 0;
 
    virtual SocketError SetOptionKeepAliveIdleTime(int seconds) = 0;
    virtual SocketError GetOptionKeepAliveIdleTime(int& seconds) = 0;
    virtual SocketError SetOptionKeepAliveProbeInterval(int seconds) = 0;
    virtual SocketError GetOptionKeepAliveProbeInterval(int& seconds) = 0;
    virtual SocketError SetOptionKeepAliveProbeCount(int probeCount) = 0;
    virtual SocketError GetOptionKeepAliveProbeCount(int& probeCount) = 0;
 
    virtual intptr GetNativeHandle() const = 0;
    virtual PeerCredentials GetPeerCredentials(SocketError& error) = 0;
};
 
}}} // end of namespace Arp::System::Ve