FIPv4Address Struct Reference

#include <IPv4Address.h>

Public Member Functions
	FIPv4Address ()
	FIPv4Address (uint8 InA, uint8 InB, uint8 InC, uint8 InD)
	FIPv4Address (uint32 InValue)
bool	operator== (const FIPv4Address &Other) const
bool	operator!= (const FIPv4Address &Other) const
FIPv4Address	operator| (const FIPv4SubnetMask &SubnetMask) const
FIPv4Address	operator& (const FIPv4SubnetMask &SubnetMask) const
bool	IsGlobalMulticast () const
bool	IsLinkLocal () const
bool	IsLinkLocalMulticast () const
bool	IsLoopbackAddress () const
bool	IsMulticastAddress () const
bool	IsOrganizationLocalMulticast () const
bool	IsSiteLocalAddress () const
bool	IsSiteLocalMulticast () const
bool	IsSessionFrontendMulticast () const
NETWORKING_API FString	ToString () const
FText	ToText () const

Static Public Member Functions
static NETWORKING_API bool	Parse (const FString &AddressString, FIPv4Address &OutAddress)

Public Attributes
union {
struct {
uint8   A
uint8   B
uint8   C
uint8   D
}
uint32   Value
};

Static Public Attributes
static NETWORKING_API const FIPv4Address	Any
static NETWORKING_API const FIPv4Address	InternalLoopback
static NETWORKING_API const FIPv4Address	LanBroadcast

Friends
FArchive &	operator<< (FArchive &Ar, FIPv4Address &IpAddress)
uint32	GetTypeHash (const FIPv4Address &Address)

Detailed Description

Implements an IPv4 address.

Constructor & Destructor Documentation

FIPv4Address() [1/3]

FIPv4Address::FIPv4Address ( )

inline

Default constructor.

FIPv4Address() [2/3]

FIPv4Address::FIPv4Address ( uint8  InA, uint8  InB, uint8  InC, uint8  InD  )

inline

Creates and initializes a new IPv4 address with the specified components.

The created IP address has the value A.B.C.D.

Parameters

InA	The first component.
InB	The second component.
InC	The third component.
InD	The fourth component.

FIPv4Address() [3/3]

FIPv4Address::FIPv4Address ( uint32  InValue )

inline

Creates and initializes a new IPv4 address with the specified value.

Parameters

InValue

The address value (in host byte order).

Member Function Documentation

IsGlobalMulticast()

bool FIPv4Address::IsGlobalMulticast ( ) const

inline

Checks whether this IP address is a global multicast address.

Global multicast addresses are in the range 224.0.1.0 to 238.255.255.255.

Returns

true if it is a global multicast address, false otherwise.

See also

IsLinkLocalMulticast, IsOrganizationLocalMulticast, IsSiteLocalMulticast

IsLinkLocal()

bool FIPv4Address::IsLinkLocal ( ) const

inline

Checks whether this IP address is link local.

Link local addresses are in the range 169.254.0.0/16

Returns

true if it is link local, false otherwise.

IsLinkLocalMulticast()

bool FIPv4Address::IsLinkLocalMulticast ( ) const

inline

Checks whether this IP address is a link local multicast address.

Link local multicast addresses have the form 224.0.0.x.

Returns

true if it is a link local multicast address, false otherwise.

See also

IsGlobalMulticast, IsOrganizationLocalMulticast, IsSiteLocalMulticast

IsLoopbackAddress()

bool FIPv4Address::IsLoopbackAddress ( ) const

inline

Checks whether this IP address is a loopback address.

Loopback addresses have the form 127.x.x.x

Returns

true if it is a loopback address, false otherwise.

See also

IsMulticastAddress

IsMulticastAddress()

bool FIPv4Address::IsMulticastAddress ( ) const

inline

Checks whether this IP address is a multicast address.

Multicast addresses are in the range 224.0.0.0 to 239.255.255.255.

Returns

true if it is a multicast address, false otherwise.

See also

IsLoopbackAddress

IsOrganizationLocalMulticast()

bool FIPv4Address::IsOrganizationLocalMulticast ( ) const

inline

Checks whether this IP address is a organization local multicast address.

Organization local multicast addresses are in the range 239.192.x.x to 239.195.x.x.

Returns

true if it is a site local multicast address, false otherwise.

See also

IsGlobalMulticast, IsLinkLocalMulticast, IsSiteLocalMulticast

IsSessionFrontendMulticast()

bool FIPv4Address::IsSessionFrontendMulticast ( ) const

inline

Checks whether this IP address is the multicast address we use for the Session Frontend Which is 230.0.0.1

Returns

true if this address matches, false otherwise.

IsSiteLocalAddress()

bool FIPv4Address::IsSiteLocalAddress ( ) const

inline

Checks whether this IP address is a site local address.

Site local addresses have one of the following forms: 10.x.x.x 172.16-31.x.x 192.168.x.x

Returns

true if it is a site local address, false otherwise.

IsSiteLocalMulticast()

bool FIPv4Address::IsSiteLocalMulticast ( ) const

inline

Checks whether this IP address is a site local multicast address.

Site local multicast addresses have the form 239.255.0.x.

Returns

true if it is a site local multicast address, false otherwise.

See also

IsGlobalMulticast, IsLinkLocalMulticast, IsOrganizationLocalMulticast

operator!=()

bool FIPv4Address::operator!= ( const FIPv4Address &  Other ) const

inline

Compares this IPv4 address with the given address for inequality.

Parameters

Other

The address to compare with.

Returns

true if the addresses are not equal, false otherwise.

operator&()

FIPv4Address FIPv4Address::operator& ( const FIPv4SubnetMask &  SubnetMask ) const

inline

AND operator for masking IP addresses with a subnet mask.

Parameters

SubnetMask

The subnet mask.

Returns

The masked IP address.

operator==()

bool FIPv4Address::operator== ( const FIPv4Address &  Other ) const

inline

Compares this IPv4 address with the given address for equality.

Parameters

Other

The address to compare with.

Returns

true if the addresses are equal, false otherwise.

operator|()

FIPv4Address FIPv4Address::operator| ( const FIPv4SubnetMask &  SubnetMask ) const

inline

OR operator for masking IP addresses with a subnet mask.

Parameters

SubnetMask

The subnet mask.

Returns

The masked IP address.

Parse()

bool FIPv4Address::Parse ( const FString &  AddressString, FIPv4Address &  OutAddress  )

static

Converts a string to an IPv4 address.

Parameters

AddressString	The string to convert.
OutAddress	Will contain the parsed address.

Returns

true if the string was converted successfully, false otherwise.

See also

ToString

ToString()

FString FIPv4Address::ToString

(

)

const

Gets the string representation for this address.

Returns

String representation.

See also

Parse, ToText

ToText()

FText FIPv4Address::ToText ( ) const

inline

Gets the display text representation.

Returns

Text representation.

See also

ToString

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FIPv4Address &  Address )

friend

Gets the hash for specified IPv4 address.

Parameters

Address

The address to get the hash for.

Returns

Hash value.

operator<<

FArchive & operator<< ( FArchive &  Ar, FIPv4Address &  IpAddress  )

friend

Serializes the given IPv4 address from or into the specified archive.

Parameters

Ar	The archive to serialize from or into.
IpAddress	The address to serialize.

Returns

The archive.

Member Data Documentation

[union]

union { ... } FIPv4Address

A

uint8 FIPv4Address::A

Any

const FIPv4Address FIPv4Address::Any

static

Defines the wild card address, which is 0.0.0.0

B

uint8 FIPv4Address::B

C

uint8 FIPv4Address::C

D

uint8 FIPv4Address::D

InternalLoopback

const FIPv4Address FIPv4Address::InternalLoopback

static

Defines the internal loopback address, which is 127.0.0.1

LanBroadcast

const FIPv4Address FIPv4Address::LanBroadcast

static

Defines the broadcast address for the 'zero network' (i.e. LAN), which is 255.255.255.255.

Value

uint32 FIPv4Address::Value

The IP address value in host byte order.

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Networking/Public/Interfaces/IPv4/IPv4Address.h
• Engine/Source/Runtime/Networking/Private/IPv4/IPv4Address.cpp