SocketsBSD.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "HAL/PlatformTime.h"
#include "BSDSockets/SocketSubsystemBSDPrivate.h"
 
#include <atomic>
 
class FInternetAddr;
 
#if PLATFORM_HAS_BSD_SOCKETS || PLATFORM_HAS_BSD_IPV6_SOCKETS
 
#include "Sockets.h"
 
 
enum class ESocketBSDParam : uint8
{
    CanRead,
    CanWrite,
    HasError,
};
 
 
enum class ESocketBSDReturn : uint8
{
    Yes,
    No,
    EncounteredError,
};
 
 
class FSocketBSD
    : public FSocket
{
public:
 
    FSocketBSD(SOCKET InSocket, ESocketType InSocketType, const FString& InSocketDescription, const FName& InSocketProtocol, ISocketSubsystem * InSubsystem)
        : FSocket(InSocketType, InSocketDescription, InSocketProtocol)
        , Socket(InSocket)
        , LastActivityTime(0.0)
        , SocketSubsystem(InSubsystem)
    { }
 
    virtual ~FSocketBSD()
    {
        FSocketBSD::Close();
    }
 
public:
 
    SOCKET GetNativeSocket()
    {
        return Socket;
    }
 
public:
 
    // FSocket overrides
 
    virtual bool Shutdown(ESocketShutdownMode Mode) override;
    virtual bool Close() override;
    virtual bool Bind(const FInternetAddr& Addr) override;
    virtual bool Connect(const FInternetAddr& Addr) override;
    virtual bool Listen(int32 MaxBacklog) override;
    virtual bool WaitForPendingConnection(bool& bHasPendingConnection, const FTimespan& WaitTime) override;
    virtual bool HasPendingData(uint32& PendingDataSize) override;
    virtual class FSocket* Accept(const FString& SocketDescription) override;
    virtual class FSocket* Accept(FInternetAddr& OutAddr, const FString& SocketDescription) override;
    virtual bool SendTo(const uint8* Data, int32 Count, int32& BytesSent, const FInternetAddr& Destination) override;
    virtual bool Send(const uint8* Data, int32 Count, int32& BytesSent) override;
    virtual bool RecvFrom(uint8* Data, int32 BufferSize, int32& BytesRead, FInternetAddr& Source, ESocketReceiveFlags::Type Flags = ESocketReceiveFlags::None) override;
    virtual bool Recv(uint8* Data,int32 BufferSize,int32& BytesRead, ESocketReceiveFlags::Type Flags = ESocketReceiveFlags::None) override;
    virtual bool Wait(ESocketWaitConditions::Type Condition, FTimespan WaitTime) override;
    virtual ESocketConnectionState GetConnectionState() override;
    virtual void GetAddress(FInternetAddr& OutAddr) override;
    virtual bool GetPeerAddress(FInternetAddr& OutAddr) override;
    virtual bool SetNonBlocking(bool bIsNonBlocking = true) override;
    virtual bool SetNoDelay(bool bIsNoDelay = true) override;
    virtual bool SetBroadcast(bool bAllowBroadcast = true) override;
    virtual bool JoinMulticastGroup(const FInternetAddr& GroupAddress) override;
    virtual bool JoinMulticastGroup(const FInternetAddr& GroupAddress, const FInternetAddr& InterfaceAddress) override;
    virtual bool LeaveMulticastGroup(const FInternetAddr& GroupAddress) override;
    virtual bool LeaveMulticastGroup(const FInternetAddr& GroupAddress, const FInternetAddr& InterfaceAddress) override;
    virtual bool SetMulticastLoopback(bool bLoopback) override;
    virtual bool SetMulticastTtl(uint8 TimeToLive) override;
    virtual bool SetMulticastInterface(const FInternetAddr& InterfaceAddress) override;
    virtual bool SetReuseAddr(bool bAllowReuse = true) override;
    virtual bool SetLinger(bool bShouldLinger = true, int32 Timeout = 0) override;
    virtual bool SetRecvErr(bool bUseErrorQueue = true) override;
    virtual bool SetSendBufferSize(int32 Size,int32& NewSize) override;
    virtual bool SetReceiveBufferSize(int32 Size,int32& NewSize) override;
    virtual int32 GetPortNo() override;
    virtual bool SetIpPktInfo(bool bEnable) override;
    virtual bool RecvFromWithPktInfo(uint8* Data, int32 BufferSize, int32& BytesRead, FInternetAddr& Source, FInternetAddr& Destination, ESocketReceiveFlags::Type Flags = ESocketReceiveFlags::None) override;
    [[nodiscard]] virtual UPTRINT ReleaseNativeSocket() override;
 
    bool SetIPv6Only(bool bIPv6Only);
 
protected:
 
    virtual ESocketBSDReturn HasState(ESocketBSDParam State, FTimespan WaitTime = FTimespan::Zero());
 
    FORCEINLINE void UpdateActivity()
    {
        LastActivityTime = FPlatformTime::Seconds();
    }
 
    SOCKET Socket;
 
    std::atomic<double> LastActivityTime { 0.0 };
 
    int SendFlags = 0;
 
    ISocketSubsystem* SocketSubsystem;
};
 
 
#endif  //PLATFORM_HAS_BSD_SOCKETS