FIPv4SubnetMask Struct Reference

#include <IPv4SubnetMask.h>

Public Member Functions
	FIPv4SubnetMask ()
	FIPv4SubnetMask (uint8 InA, uint8 InB, uint8 InC, uint8 InD)
	FIPv4SubnetMask (uint32 InValue)
bool	operator== (const FIPv4SubnetMask &Other) const
bool	operator!= (const FIPv4SubnetMask &Other) const
FIPv4SubnetMask	operator~ () const
EIPv4SubnetClasses::Type	GetClass () const
NETWORKING_API FString	ToString () const
FText	ToText () const

Static Public Member Functions
static NETWORKING_API bool	Parse (const FString &MaskString, FIPv4SubnetMask &OutMask)

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

Friends
FArchive &	operator<< (FArchive &Ar, FIPv4SubnetMask &SubnetMask)
uint32	GetTypeHash (const FIPv4SubnetMask &SubnetMask)

Detailed Description

Implements an IPv4 subnet mask.

Constructor & Destructor Documentation

FIPv4SubnetMask() [1/3]

FIPv4SubnetMask::FIPv4SubnetMask ( )

inline

Default constructor.

FIPv4SubnetMask() [2/3]

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

inline

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

The created subnet mask has the value A.B.C.D.

Parameters

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

FIPv4SubnetMask() [3/3]

FIPv4SubnetMask::FIPv4SubnetMask ( uint32  InValue )

inline

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

Parameters

InValue

The address value (in host byte order).

Member Function Documentation

GetClass()

EIPv4SubnetClasses::Type FIPv4SubnetMask::GetClass ( ) const

inline

Gets the subnet class that this mask specifies.

Returns

Subnet class.

operator!=()

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

inline

Compares this subnet mask with the given address for inequality.

Parameters

Other

The subnet mask to compare with.

Returns

true if the subnet masks are not equal, false otherwise.

operator==()

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

inline

Compares this subnet mask with the given mask for equality.

Parameters

Other

The subnet mask to compare with.

Returns

true if the subnet masks are equal, false otherwise.

operator~()

FIPv4SubnetMask FIPv4SubnetMask::operator~ ( ) const

inline

Returns an inverted subnet mask.

Returns

Inverted subnet mask.

Parse()

bool FIPv4SubnetMask::Parse ( const FString &  MaskString, FIPv4SubnetMask &  OutMask  )

static

Converts a string to an IPv4 subnet mask.

Parameters

MaskString	The string to convert.
OutMask	Will contain the parsed subnet mask.

Returns

true if the string was converted successfully, false otherwise.

See also

ToString

ToString()

FString FIPv4SubnetMask::ToString

(

)

const

Converts this IP address to its string representation.

Returns

String representation.

See also

Parse, ToText

ToText()

FText FIPv4SubnetMask::ToText ( ) const

inline

Gets the display text representation.

Returns

Text representation.

See also

ToString

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FIPv4SubnetMask &  SubnetMask )

friend

Gets the hash for specified IPv4 subnet mask.

Parameters

SubnetMask

The subnet mask to get the hash for.

Returns

Hash value.

operator<<

FArchive & operator<< ( FArchive &  Ar, FIPv4SubnetMask &  SubnetMask  )

friend

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

Parameters

Ar	The archive to serialize from or into.
SubnetMask	The subnet mask to serialize.

Returns

The archive.

Member Data Documentation

[union]

union { ... } FIPv4SubnetMask

A

uint8 FIPv4SubnetMask::A

B

uint8 FIPv4SubnetMask::B

C

uint8 FIPv4SubnetMask::C

D

uint8 FIPv4SubnetMask::D

Value

int32 FIPv4SubnetMask::Value

The subnet mask value in host byte order.

---

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

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