IPAddress.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/Map.h"
#include "Containers/Set.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "HAL/PlatformAtomics.h"
#include "Misc/AssertionMacros.h"
#include "SocketTypes.h"
#include "Templates/SharedPointer.h"
#include "UObject/NameTypes.h"
#include "UObject/UnrealNames.h"
 
class FInternetAddr
{
protected:
    FInternetAddr()
    {
    }
 
public:
 
    virtual ~FInternetAddr() 
    {
    }
 
    virtual bool CompareEndpoints(const FInternetAddr& InAddr) const
    {
        return *this == InAddr;
    }
 
    virtual void SetIp(uint32 InAddr) = 0;
    
    virtual void SetIp(const TCHAR* InAddr, bool& bIsValid) = 0;
 
    virtual void GetIp(uint32& OutAddr) const = 0;
 
    virtual void SetPort(int32 InPort) = 0;
 
    virtual bool IsPortValid(int32 InPort) const { return true; }
 
    virtual void GetPort(int32& OutPort) const
    {
        OutPort = GetPort();
    }
 
    virtual int32 GetPort() const = 0;
 
    virtual void SetPlatformPort(int32 InPort)
    {
        SetPort(InPort);
    }
 
    virtual int32 GetPlatformPort() const
    {
        return GetPort();
    }
 
    virtual void SetRawIp(const TArray<uint8>& RawAddr) = 0;
 
    virtual TArray<uint8> GetRawIp() const = 0;
 
    virtual void SetAnyAddress() = 0;
 
    virtual void SetBroadcastAddress() = 0;
 
    virtual void SetLoopbackAddress() = 0;
 
    virtual FString ToString(bool bAppendPort) const = 0;
 
    virtual bool operator==(const FInternetAddr& Other) const
    {
        TArray<uint8> ThisIP = GetRawIp();
        TArray<uint8> OtherIP = Other.GetRawIp();
        return ThisIP == OtherIP && GetPort() == Other.GetPort();
    }
 
    virtual uint32 GetTypeHash() const = 0;
 
    virtual bool IsValid() const = 0;
    
    virtual TSharedRef<FInternetAddr> Clone() const = 0;
 
    virtual FName GetProtocolType() const
    {
        return NAME_None;
    }
 
    SOCKETS_API virtual void DumpAddrData() const;
 
    friend inline uint32 GetTypeHash(const FInternetAddr& InAddr)
    {
        return InAddr.GetTypeHash();
    }
};
 
 
template<typename ValueType>
struct FInternetAddrKeyMapFuncs : public BaseKeyFuncs<ValueType, TSharedRef<FInternetAddr>, false>
{
    static inline const TSharedRef<FInternetAddr>& GetSetKey(const TPair<TSharedRef<FInternetAddr>, ValueType>& Element)
    {
        return Element.Key;
    }
 
    static inline bool Matches(const TSharedRef<FInternetAddr>& A, const TSharedRef<FInternetAddr>& B)
    {
        return *A == *B;
    }
 
    static inline uint32 GetKeyHash(const TSharedRef<FInternetAddr>& Key)
    {
        return Key->GetTypeHash();
    }
};
 
template<typename ValueType>
struct FInternetAddrConstKeyMapFuncs : public BaseKeyFuncs<ValueType, TSharedRef<const FInternetAddr>, false>
{
    static inline const TSharedRef<const FInternetAddr>& GetSetKey(const TPair<TSharedRef<const FInternetAddr>, ValueType>& Element)
    {
        return Element.Key;
    }
 
    static inline bool Matches(const TSharedRef<const FInternetAddr>& A, const TSharedRef<const FInternetAddr>& B)
    {
        return *A == *B;
    }
 
    static inline uint32 GetKeyHash(const TSharedRef<const FInternetAddr>& Key)
    {
        return Key->GetTypeHash();
    }
};