SocketSubsystemBSD.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/OutputDeviceRedirector.h"
#include "HAL/IConsoleManager.h"
#include "SocketSubsystemPackage.h"
#include "SocketSubsystem.h"
#include "IPAddress.h"
 
#if PLATFORM_HAS_BSD_SOCKETS || PLATFORM_HAS_BSD_IPV6_SOCKETS
 
class FSocketBSD;
extern TAutoConsoleVariable<int32> CVarDisableIPv6;
 
#include "SocketSubsystemBSDPrivate.h"
 
class FSocketSubsystemBSD : public ISocketSubsystem
{
public:
    virtual FName GetDefaultSocketProtocolFamily() const
    {
        return FNetworkProtocolTypes::IPv4;
    }
 
 
    // ISocketSubsystem interface
    virtual TSharedRef<FInternetAddr> CreateInternetAddr() override;
    virtual TSharedRef<FInternetAddr> CreateInternetAddr(const FName ProtocolType) override;
 
    virtual class FSocket* CreateSocket(const FName& SocketType, const FString& SocketDescription, bool bForceUDP = false) override
    {
        return CreateSocket(SocketType, SocketDescription, GetDefaultSocketProtocolFamily());
    }
 
    virtual class FSocket* CreateSocket(const FName& SocketType, const FString& SocketDescription, const FName& ProtocolType) override;
 
    virtual void DestroySocket( class FSocket* Socket ) override;
 
    virtual FAddressInfoResult GetAddressInfo(const TCHAR* HostName, const TCHAR* ServiceName = nullptr,
        EAddressInfoFlags QueryFlags = EAddressInfoFlags::Default,
        const FName ProtocolTypeName = NAME_None,
        ESocketType SocketType = ESocketType::SOCKTYPE_Unknown) override;
 
    virtual TSharedPtr<FInternetAddr> GetAddressFromString(const FString& InAddress) override;
 
    virtual bool GetMultihomeAddress(TSharedRef<FInternetAddr>& Addr) override;
 
    virtual bool GetHostName(FString& HostName) override;
    virtual ESocketErrors GetLastErrorCode() override;
 
    virtual const TCHAR* GetSocketAPIName() const override;
 
    virtual bool RequiresChatDataBeSeparate() override
    {
        return false;
    }
 
    virtual bool RequiresEncryptedPackets() override
    {
        return false;
    }
 
    virtual ESocketErrors TranslateErrorCode( int32 Code ) override;
 
    virtual bool IsSocketWaitSupported() const override;
 
    virtual TSharedRef<FInternetAddr> GetLocalHostAddr(FOutputDevice& Out, bool& bCanBindAll) override;
 
    UE_DEPRECATED(4.23, "Switch to the FName version for scalable protocol support")
    virtual int32 GetProtocolFamilyValue(ESocketProtocolFamily InProtocol) const;
    virtual int32 GetProtocolFamilyValue(const FName& InProtocol) const;
    
    virtual const FName GetProtocolFamilyTypeName(int32 InProtocol) const;
 
    UE_DEPRECATED(4.23, "Use GetProtocolFamilyTypeName")
    virtual ESocketProtocolFamily GetProtocolFamilyType(int32 InProtocol) const;
    
 
    virtual ESocketType GetSocketType(int32 InSocketType) const;
 
    virtual int32 GetAddressInfoHintFlag(EAddressInfoFlags InFlags) const;
 
protected:
    ESocketErrors TranslateGAIErrorCode(int32 Code) const;
 
    virtual class FSocketBSD* InternalBSDSocketFactory( SOCKET Socket, ESocketType SocketType, const FString& SocketDescription, const FName& SocketProtocol);
 
    UE_DEPRECATED(4.22, "To support multiple stack types, move to the constructor that allows for specifying the protocol stack to initialize the socket on.")
    virtual class FSocketBSD* InternalBSDSocketFactory(SOCKET Socket, ESocketType SocketType, const FString& SocketDescription)
    {
        return InternalBSDSocketFactory(Socket, SocketType, SocketDescription, GetDefaultSocketProtocolFamily());
    }
 
    bool GetLocalHostAddrViaConnect(TSharedRef<FInternetAddr>& HostAddr);
 
    // allow BSD sockets to use this when creating new sockets from accept() etc
    friend FSocketBSD;
};
 
#endif