OpenJAUS SAE SDK  6.0.0
Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
openjaus::system::NetworkInterface Class Reference

This is a brief description. More...

#include <NetworkInterface.h>

Public Member Functions

 NetworkInterface ()
 
virtual ~NetworkInterface ()
 
std::string getName () const
 Accessor to get the value of name. More...
 
bool setName (std::string name)
 Accessor to set value of name. More...
 
const InetAddressgetAddress () const
 Accessor to get the value of address. More...
 
bool setAddress (const InetAddress &address)
 Accessor to set value of address. More...
 
const InetAddressgetNetmask () const
 Accessor to get the value of netmask. More...
 
bool setNetmask (const InetAddress &netmask)
 Accessor to set value of netmask. More...
 
const InetAddressgetBroadcast () const
 Accessor to get the value of broadcast. More...
 
bool setBroadcast (const InetAddress &broadcast)
 Accessor to set value of broadcast. More...
 
virtual std::string toString () const
 

Static Public Member Functions

static NetworkInterface anyInterface ()
 
static NetworkInterface loopback ()
 
static bool getByName (std::string name, NetworkInterface &interface)
 

Protected Attributes

std::string name
 
InetAddress address
 
InetAddress netmask
 
InetAddress broadcast
 

Friends

OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const NetworkInterface &object)
 
OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const NetworkInterface *object)
 

Detailed Description

Detailed description.

Author
Name (name@.nosp@m.emai.nosp@m.l.com)

Constructor & Destructor Documentation

◆ NetworkInterface()

openjaus::system::NetworkInterface::NetworkInterface ( )

◆ ~NetworkInterface()

openjaus::system::NetworkInterface::~NetworkInterface ( )
virtual

Member Function Documentation

◆ anyInterface()

NetworkInterface openjaus::system::NetworkInterface::anyInterface ( )
static

◆ getAddress()

const InetAddress & openjaus::system::NetworkInterface::getAddress ( ) const

◆ getBroadcast()

const InetAddress & openjaus::system::NetworkInterface::getBroadcast ( ) const

◆ getByName()

bool openjaus::system::NetworkInterface::getByName ( std::string  name,
NetworkInterface interface 
)
static

◆ getName()

std::string openjaus::system::NetworkInterface::getName ( ) const

◆ getNetmask()

const InetAddress & openjaus::system::NetworkInterface::getNetmask ( ) const

◆ loopback()

NetworkInterface openjaus::system::NetworkInterface::loopback ( )
static

◆ setAddress()

bool openjaus::system::NetworkInterface::setAddress ( const InetAddress address)
Parameters
addressThe value of the new address.

◆ setBroadcast()

bool openjaus::system::NetworkInterface::setBroadcast ( const InetAddress broadcast)
Parameters
broadcastThe value of the new broadcast.

◆ setName()

bool openjaus::system::NetworkInterface::setName ( std::string  name)
Parameters
nameThe value of the new name.

◆ setNetmask()

bool openjaus::system::NetworkInterface::setNetmask ( const InetAddress netmask)
Parameters
netmaskThe value of the new netmask.

◆ toString()

std::string openjaus::system::NetworkInterface::toString ( ) const
virtual

Friends And Related Function Documentation

◆ operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const NetworkInterface object 
)
friend

◆ operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const NetworkInterface object 
)
friend

Member Data Documentation

◆ address

InetAddress openjaus::system::NetworkInterface::address
protected

◆ broadcast

InetAddress openjaus::system::NetworkInterface::broadcast
protected

◆ name

std::string openjaus::system::NetworkInterface::name
protected

◆ netmask

InetAddress openjaus::system::NetworkInterface::netmask
protected

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