Bayonne2 / Common C++ 2 Framework
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Private Attributes | Friends
NetworkDeviceInfo Class Reference

Network device information class. More...

#include <network.h>

Collaboration diagram for NetworkDeviceInfo:
Collaboration graph
[legend]

Public Member Functions

 NetworkDeviceInfo (const NetworkDeviceInfo &ndi)
 
 ~NetworkDeviceInfo ()
 
const Stringname () const
 Returns the Name of the network device. More...
 
const InetHostAddressaddress () const
 Returns the Address of the network device. More...
 
const BroadcastAddressbroadcast () const
 Returns the Broadcast address of the network device. More...
 
const InetMaskAddressnetmask () const
 Returns the Netmask of the network device. More...
 
const int mtu () const
 Returns the MTU. More...
 

Protected Member Functions

 NetworkDeviceInfo (const String &name, const InetHostAddress &addr, const BroadcastAddress &broadcast, const InetMaskAddress &netmask, int mtu)
 

Private Attributes

String _name
 
InetHostAddress _addr
 
BroadcastAddress _broadcast
 
InetMaskAddress _netmask
 
int _mtu
 

Friends

__EXPORT bool enumNetworkDevices (std::vector< NetworkDeviceInfo > &devs)
 Enumerate all available network devices. More...
 

Detailed Description

Network device information class.

This class is used to hold various informations about a TCP/IP network device. Which can be obtained by a call to enumNetworkDevices()

Author
Christian Prochnow cproc.nosp@m.h@se.nosp@m.culog.nosp@m.ix.d.nosp@m.e

Definition at line 72 of file network.h.

Constructor & Destructor Documentation

NetworkDeviceInfo::NetworkDeviceInfo ( const String name,
const InetHostAddress addr,
const BroadcastAddress broadcast,
const InetMaskAddress netmask,
int  mtu 
)
protected
NetworkDeviceInfo::NetworkDeviceInfo ( const NetworkDeviceInfo ndi)
NetworkDeviceInfo::~NetworkDeviceInfo ( )

Member Function Documentation

const InetHostAddress& NetworkDeviceInfo::address ( ) const
inline

Returns the Address of the network device.

Definition at line 95 of file network.h.

const BroadcastAddress& NetworkDeviceInfo::broadcast ( ) const
inline

Returns the Broadcast address of the network device.

Definition at line 99 of file network.h.

const int NetworkDeviceInfo::mtu ( ) const
inline

Returns the MTU.

Definition at line 107 of file network.h.

const String& NetworkDeviceInfo::name ( ) const
inline

Returns the Name of the network device.

Definition at line 91 of file network.h.

const InetMaskAddress& NetworkDeviceInfo::netmask ( ) const
inline

Returns the Netmask of the network device.

Definition at line 103 of file network.h.

Friends And Related Function Documentation

__EXPORT bool enumNetworkDevices ( std::vector< NetworkDeviceInfo > &  devs)
friend

Enumerate all available network devices.

Field Documentation

InetHostAddress NetworkDeviceInfo::_addr
private

Definition at line 76 of file network.h.

BroadcastAddress NetworkDeviceInfo::_broadcast
private

Definition at line 77 of file network.h.

int NetworkDeviceInfo::_mtu
private

Definition at line 79 of file network.h.

String NetworkDeviceInfo::_name
private

Definition at line 75 of file network.h.

InetMaskAddress NetworkDeviceInfo::_netmask
private

Definition at line 78 of file network.h.


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