CoreComponents 3.0.0
A Modern C++ Toolkit
Loading...
Searching...
No Matches
NetworkState Class Referencefinal

Simplified network configuration state. More...

#include <cc/NetworkState>

Inheritance diagram for NetworkState:

Public Member Functions

 NetworkState (const String &interfaceName="")
 Get the current network configuration state.
 
String interfaceName () const
 Name of the network interface.
 
const NetworkInterfaceinterface () const
 Network interface.
 
int networkMask () const
 Size of the network mask (IPv4 only)
 
SocketAddress address () const
 Configured address.
 
SocketAddress gateway () const
 Configured gateway.
 
- Public Member Functions inherited from Object
 Object ()=default
 Create a null object.
 
 operator bool () const
 Check if this is a non-null object.
 
bool isNull () const
 Check if this is a null object.
 
template<class T >
bool is () const
 Check if this object is of type T.
 
template<class T >
as () const
 Cast this object to type T.
 
bool isWeak () const
 Check if the underlying object reference is weak.
 
bool operator== (const Object &other) const
 Equality operator.
 
std::strong_ordering operator<=> (const Object &other) const
 Ordering operator.
 
long useCount () const
 Reference count.
 

Additional Inherited Members

- Protected Member Functions inherited from Object
template<class T >
weak () const
 
template<class T >
void initOnce ()
 Create the object state when called the first time.
 
template<class T >
void initOncePerThread ()
 Create a distinct object state for each thread when called the first time in that thread.
 
 Object (State *newState)
 Initialize object with newState.
 
 Object (State *state, Alias)
 
 Object (State *state, Weak)
 
Objectoperator= (std::nullptr_t)
 
- Static Protected Member Functions inherited from Object
template<class T >
static T alias (const State *state)
 Create an alias object for the given state.
 
template<class T >
static T weak (const State *state)
 
- Protected Attributes inherited from Object
Handle< Stateme
 Internal object state
 

Detailed Description

Simplified network configuration state.

Constructor & Destructor Documentation

◆ NetworkState()

NetworkState ( const String & interfaceName = "")
explicit

Get the current network configuration state.

Parameters
interfaceNameName of the primary network interface (optional)

Member Function Documentation

◆ interfaceName()

String interfaceName ( ) const

Name of the network interface.

◆ interface()

const NetworkInterface & interface ( ) const

Network interface.

◆ networkMask()

int networkMask ( ) const

Size of the network mask (IPv4 only)

◆ address()

SocketAddress address ( ) const

Configured address.

◆ gateway()

SocketAddress gateway ( ) const

Configured gateway.