FIPv4Subnet Struct Reference

#include <IPv4Subnet.h>

Public Member Functions
	FIPv4Subnet ()
	FIPv4Subnet (const FIPv4Address &InAddress, const FIPv4SubnetMask &InMask)
bool	operator== (const FIPv4Subnet &Other) const
bool	operator!= (const FIPv4Subnet &Other) const
FIPv4Address	BroadcastAddress () const
bool	ContainsAddress (const FIPv4Address &TestAddress)
NETWORKING_API FString	ToString () const
FText	ToText () const

Static Public Member Functions
static NETWORKING_API bool	Parse (const FString &SubnetString, FIPv4Subnet &OutSubnet)

Public Attributes
FIPv4Address	Address
FIPv4SubnetMask	Mask

Friends
FArchive &	operator<< (FArchive &Ar, FIPv4Subnet &Subnet)
uint32	GetTypeHash (const FIPv4Subnet &Subnet)

Detailed Description

Implements a IPv4 subnet descriptor.

Constructor & Destructor Documentation

FIPv4Subnet() [1/2]

FIPv4Subnet::FIPv4Subnet ( )

inline

Default constructor.

FIPv4Subnet() [2/2]

FIPv4Subnet::FIPv4Subnet ( const FIPv4Address &  InAddress, const FIPv4SubnetMask &  InMask  )

inline

Creates and initializes a new IPv4 subnet with the specified address and mask.

Parameters

InAddress	The subnet's address.
InMask	The subnet's mask.

Member Function Documentation

BroadcastAddress()

FIPv4Address FIPv4Subnet::BroadcastAddress ( ) const

inline

Get the broadcast address for this subnet.

Returns

The broadcast address.

ContainsAddress()

bool FIPv4Subnet::ContainsAddress ( const FIPv4Address &  TestAddress )

inline

Checks whether the subnet contains the specified IP address.

Parameters

TestAddress

The address to check.

Returns

true if the subnet contains the address, false otherwise.

operator!=()

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

inline

Compares this IPv4 subnet descriptor with the given subnet for inequality.

Parameters

Other

The subnet to compare with.

Returns

true if the subnets are not equal, false otherwise.

operator==()

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

inline

Compares this IPv4 subnet descriptor with the given subnet for equality.

Parameters

Other

The subnet to compare with.

Returns

true if the subnets are equal, false otherwise.

Parse()

bool FIPv4Subnet::Parse ( const FString &  SubnetString, FIPv4Subnet &  OutSubnet  )

static

Converts a string to an IPv4 subnet.

Parameters

SubnetString	The string to convert.
OutSubnet	Will contain the parsed subnet.

Returns

true if the string was converted successfully, false otherwise.

See also

ToString

ToString()

FString FIPv4Subnet::ToString

(

)

const

Converts this IP subnet to its string representation.

Returns

String representation.

See also

Parse, ToText

ToText()

FText FIPv4Subnet::ToText ( ) const

inline

Gets the display text representation.

Returns

Text representation.

See also

ToString

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FIPv4Subnet &  Subnet )

friend

Gets the hash for specified IPv4 subnet.

Parameters

Subnet

The subnet to get the hash for.

Returns

Hash value.

operator<<

FArchive & operator<< ( FArchive &  Ar, FIPv4Subnet &  Subnet  )

friend

Serializes the given subnet descriptor from or into the specified archive.

Parameters

Ar	The archive to serialize from or into.
Subnet	The subnet descriptor to serialize.

Returns

The archive.

Member Data Documentation

Address

FIPv4Address FIPv4Subnet::Address

Holds the subnet's address.

Mask

FIPv4SubnetMask FIPv4Subnet::Mask

Holds the subnet's mask.

---

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

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