Sockets.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "Misc/Timespan.h"
#include "SocketTypes.h"
#include "UObject/NameTypes.h"
#include "UObject/UnrealNames.h"
 
class FInternetAddr;
 
class FSocket : public TSharedFromThis<FSocket, ESPMode::ThreadSafe>
{
protected:
 
    const ESocketType SocketType;
 
    FString SocketDescription;
 
    FName SocketProtocol;
 
public:
 
    SOCKETS_API FSocket();
 
    UE_DEPRECATED(4.22, "Please migrate to the constructor that specifies protocol stack")
    inline FSocket(ESocketType InSocketType, const FString& InSocketDescription) :
        SocketType(InSocketType),
        SocketDescription(InSocketDescription),
        SocketProtocol(NAME_None)
    { }
 
    UE_DEPRECATED(4.23, "Please migrate to the constructor that takes an FName for the protocol stack")
        inline FSocket(ESocketType InSocketType, const FString& InSocketDescription, ESocketProtocolFamily InSocketProtocol) :
        SocketType(InSocketType),
        SocketDescription(InSocketDescription)
    { 
        if (InSocketProtocol == ESocketProtocolFamily::IPv4)
        {
            SocketProtocol = FNetworkProtocolTypes::IPv4;
        }
        else if (InSocketProtocol == ESocketProtocolFamily::IPv6)
        {
            SocketProtocol = FNetworkProtocolTypes::IPv6;
        }
        else
        {
            SocketProtocol = NAME_None;
        }
    }
 
    SOCKETS_API FSocket(ESocketType InSocketType, const FString& InSocketDescription, const FName& InSocketProtocol);
 
    SOCKETS_API virtual ~FSocket();
 
    virtual bool Shutdown(ESocketShutdownMode Mode) = 0;
 
    virtual bool Close() = 0;
 
    [[nodiscard]] virtual UPTRINT ReleaseNativeSocket() { return 0; }
 
    virtual bool Bind(const FInternetAddr& Addr) = 0;
 
    virtual bool Connect(const FInternetAddr& Addr) = 0;
 
    virtual bool Listen(int32 MaxBacklog) = 0;
 
    virtual bool WaitForPendingConnection(bool& bHasPendingConnection, const FTimespan& WaitTime) = 0;
 
    bool HasPendingConnection(bool& bHasPendingConnection)
    {
        return WaitForPendingConnection(bHasPendingConnection, FTimespan::Zero());
    }
 
    virtual bool HasPendingData(uint32& PendingDataSize) = 0;
 
    virtual class FSocket* Accept(const FString& InSocketDescription) = 0;
 
    virtual class FSocket* Accept(FInternetAddr& OutAddr, const FString& InSocketDescription) = 0;
 
    SOCKETS_API virtual bool SendTo(const uint8* Data, int32 Count, int32& BytesSent, const FInternetAddr& Destination);
 
    SOCKETS_API virtual bool Send(const uint8* Data, int32 Count, int32& BytesSent);
 
    SOCKETS_API virtual bool RecvFrom(uint8* Data, int32 BufferSize, int32& BytesRead, FInternetAddr& Source, ESocketReceiveFlags::Type Flags = ESocketReceiveFlags::None);
 
    SOCKETS_API virtual bool Recv(uint8* Data, int32 BufferSize, int32& BytesRead, ESocketReceiveFlags::Type Flags = ESocketReceiveFlags::None);
 
    SOCKETS_API virtual bool RecvMulti(FRecvMulti& MultiData, ESocketReceiveFlags::Type Flags=ESocketReceiveFlags::None);
 
    virtual bool Wait(ESocketWaitConditions::Type Condition, FTimespan WaitTime) = 0;
 
    virtual ESocketConnectionState GetConnectionState() = 0;
 
    virtual void GetAddress(FInternetAddr& OutAddr) = 0;
 
    virtual bool GetPeerAddress(FInternetAddr& OutAddr) = 0;
 
    virtual bool SetNonBlocking(bool bIsNonBlocking = true) = 0;
 
    virtual bool SetBroadcast(bool bAllowBroadcast = true) = 0;
 
    virtual bool SetNoDelay(bool bIsNoDelay = true) = 0;
 
    virtual bool JoinMulticastGroup(const FInternetAddr& GroupAddress) = 0;
 
    virtual bool JoinMulticastGroup(const FInternetAddr& GroupAddress, const FInternetAddr& InterfaceAddress) = 0;
 
    virtual bool LeaveMulticastGroup(const FInternetAddr& GroupAddress) = 0;
 
    virtual bool LeaveMulticastGroup(const FInternetAddr& GroupAddress, const FInternetAddr& InterfaceAddress) = 0;
 
    virtual bool SetMulticastLoopback(bool bLoopback) = 0;
 
    virtual bool SetMulticastTtl(uint8 TimeToLive) = 0;
 
    virtual bool SetMulticastInterface(const FInternetAddr& InterfaceAddress) = 0;
 
    virtual bool SetReuseAddr(bool bAllowReuse = true) = 0;
 
    virtual bool SetLinger(bool bShouldLinger = true, int32 Timeout = 0) = 0;
 
    virtual bool SetRecvErr(bool bUseErrorQueue = true) = 0;
 
    virtual bool SetSendBufferSize(int32 Size, int32& NewSize) = 0;
 
    virtual bool SetReceiveBufferSize(int32 Size, int32& NewSize) = 0;
 
    SOCKETS_API virtual bool SetRetrieveTimestamp(bool bRetrieveTimestamp=true);
 
    virtual int32 GetPortNo() = 0;
 
    SOCKETS_API virtual bool SetIpPktInfo(bool bEnable);
 
    SOCKETS_API virtual bool RecvFromWithPktInfo(uint8* Data, int32 BufferSize, int32& BytesRead, FInternetAddr& Source, FInternetAddr& Destination, ESocketReceiveFlags::Type Flags = ESocketReceiveFlags::None);
 
    inline ESocketType GetSocketType() const
    {
        return SocketType;
    }
 
    inline FString GetDescription() const
    {
        return SocketDescription;
    }
 
    inline FName GetProtocol() const
    {
        return SocketProtocol;
    }
};