IPv4Address.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 "HAL/Platform.h"
#include "Interfaces/IPv4/IPv4SubnetMask.h"
#include "Internationalization/Text.h"
#include "Serialization/Archive.h"
 
struct FIPv4Address
{
    union
    {
        struct
        {
#if PLATFORM_LITTLE_ENDIAN
    #ifdef _MSC_VER
            uint8 D, C, B, A;
    #else
            uint8 D GCC_ALIGN(4);
            uint8 C, B, A;
    #endif
#else
            uint8 A, B, C, D;
#endif
        };
 
        uint32 Value;
    };
 
public:
    
    FIPv4Address() { }
 
    FIPv4Address(uint8 InA, uint8 InB, uint8 InC, uint8 InD)
#if PLATFORM_LITTLE_ENDIAN
        : D(InD)
        , C(InC)
        , B(InB)
        , A(InA)
#else
        : A(InA)
        , B(InB)
        , C(InC)
        , D(InD)
#endif // PLATFORM_LITTLE_ENDIAN
    { }
 
    FIPv4Address(uint32 InValue)
        : Value(InValue)
    { }
 
public:
 
    bool operator==(const FIPv4Address& Other) const
    {
        return (Value == Other.Value);
    }
 
    bool operator!=(const FIPv4Address& Other) const
    {
        return (Value != Other.Value);
    }
 
    FIPv4Address operator|(const FIPv4SubnetMask& SubnetMask) const
    {
        return FIPv4Address(Value | SubnetMask.Value);
    }
 
    FIPv4Address operator&(const FIPv4SubnetMask& SubnetMask) const
    {
        return FIPv4Address(Value & SubnetMask.Value);
    }
 
    friend FArchive& operator<<(FArchive& Ar, FIPv4Address& IpAddress)
    {
        return Ar << IpAddress.Value;
    }
 
public:
 
    bool IsGlobalMulticast() const
    {
        return (((A >= 224) && A <= 238) && !((A == 224) && (B == 0) && (C == 0)));
    }
 
    bool IsLinkLocal() const
    {
        return ((A == 169) && (B == 254));
    }
 
    bool IsLinkLocalMulticast() const
    {
        return ((A >= 224) && (B == 0) && (C == 0));
    }
 
    bool IsLoopbackAddress() const
    {
        return (A == 127);
    }
 
    bool IsMulticastAddress() const
    {
        return ((A >= 224) && (A <= 239));
    }
 
    bool IsOrganizationLocalMulticast() const
    {
        return ((A == 239) && (B >= 192) && (B <= 195));
    }
 
    bool IsSiteLocalAddress() const
    {
        return ((A == 10) || ((A == 172) && ((B >= 16) && (B <= 31))) || ((A == 192) && (B == 168)));
    }
 
    bool IsSiteLocalMulticast() const
    {
        return ((A == 239) && (B == 255));
    }
 
    bool IsSessionFrontendMulticast() const
    {
        return (A == 230 && B == 0 && C == 0 && D == 1);
    }
 
    NETWORKING_API FString ToString() const;
 
    FText ToText() const
    {
        return FText::FromString(ToString());
    }
 
public:
 
    friend uint32 GetTypeHash(const FIPv4Address& Address)
    {
        return Address.Value;
    }
 
public:
 
    static NETWORKING_API bool Parse(const FString& AddressString, FIPv4Address& OutAddress);
 
public:
 
    static NETWORKING_API const FIPv4Address Any;
 
    static NETWORKING_API const FIPv4Address InternalLoopback;
 
    static NETWORKING_API const FIPv4Address LanBroadcast;
};