NetworkInterface Class Reference

An aggregation of information about a network interface. More...

#include <NetworkInterface.h++>

Collaboration diagram for NetworkInterface:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 ~NetworkInterface () throw ()
 Destructor.
String getName () const
 Get the interface name.
InetAddress getAddress () const
 Get the unicast address.
MACAddress getHardwareAddress () const
 Get the hardware (MAC) address.
InetAddress getBroadcastAddress () const throw ()
 Get the broadcast address.
InetAddress getDestAddress () const throw ()
 Get the destination address.
InetAddress getNetMask () const throw ()
 Get the netmask.
uint_t getPrefixLength () const throw ()
 Get the subnet prefix length.
uint32_t getFlags () const throw ()
 Get the interface flags.
bool isUp () const throw ()
 Test if the interface is up.
bool isBroadcastSupported () const throw ()
 Test if the interface has broadcast capability.
bool isMulticastSupported () const throw ()
 Test if the interface has multicast capability.
bool isDebuggingEnabled () const throw ()
 Test if the interface has debugging enabled.
bool isLoopback () const throw ()
 Test if the interface is a loopback interface.
bool isPPP () const throw ()
 Test if the interface is a PPP interface.
bool isNoTrailers () const throw ()
 Test if the interface does not use trailers.
bool isRunning () const throw ()
 Test if the interface is running.
bool isNoARP () const throw ()
 Test if the interface rejects Address Resolution Protocol (ARP) requests.
bool isPromiscuous () const throw ()
 Test if the interface is in promiscuous mode.
int getMTU () const throw ()
 Get the maximum transmission unit (MTU).
int getMetric () const throw ()
 Get the routing metric.

Static Public Attributes

static const uint32_t FLAG_UP = 0x0001
 A flag indicating that an interface is up.
static const uint32_t FLAG_BROADCAST = 0x0002
 A flag indicating that an interface has broadcast capability.
static const uint32_t FLAG_DEBUG = 0x0004
 A flag indicating that an interface has debugging enabled.
static const uint32_t FLAG_LOOPBACK = 0x0008
 A flag identifying an interface as a loopback interface.
static const uint32_t FLAG_PPP = 0x0010
 A flag identifying an interface as a Point-to-Point link interface.
static const uint32_t FLAG_NOTRAILERS = 0x0020
 A flag indicating that an interface does not use trailers.
static const uint32_t FLAG_RUNNING = 0x0040
 A flag indicating that an interface is running.
static const uint32_t FLAG_NOARP = 0x0080
 A flag indicating that an interface rejects Address Resolution Protocol (ARP) requests.
static const uint32_t FLAG_PROMISCUOUS = 0x0100
 A flag indicating that an interface is in promiscuous mode.
static const uint32_t FLAG_MULTICAST = 0x0200
 A flag indicating that an interface has multicast capability.
static const uint32_t FLAG_MASK = 0x03FF
 Flag mask (all flag bits set).

Friends

class Network


Detailed Description

An aggregation of information about a network interface.

Author:
Mark Lindner

Constructor & Destructor Documentation

~NetworkInterface (  )  throw ()

Destructor.


Member Function Documentation

InetAddress getAddress (  )  const [inline]

Get the unicast address.

InetAddress getBroadcastAddress (  )  const throw () [inline]

Get the broadcast address.

InetAddress getDestAddress (  )  const throw () [inline]

Get the destination address.

uint32_t getFlags (  )  const throw () [inline]

Get the interface flags.

MACAddress getHardwareAddress (  )  const [inline]

Get the hardware (MAC) address.

int getMetric (  )  const throw () [inline]

Get the routing metric.

int getMTU (  )  const throw () [inline]

Get the maximum transmission unit (MTU).

String getName (  )  const [inline]

Get the interface name.

InetAddress getNetMask (  )  const throw () [inline]

Get the netmask.

uint_t getPrefixLength (  )  const throw () [inline]

Get the subnet prefix length.

bool isBroadcastSupported (  )  const throw () [inline]

Test if the interface has broadcast capability.

bool isDebuggingEnabled (  )  const throw () [inline]

Test if the interface has debugging enabled.

bool isLoopback (  )  const throw () [inline]

Test if the interface is a loopback interface.

bool isMulticastSupported (  )  const throw () [inline]

Test if the interface has multicast capability.

bool isNoARP (  )  const throw () [inline]

Test if the interface rejects Address Resolution Protocol (ARP) requests.

bool isNoTrailers (  )  const throw () [inline]

Test if the interface does not use trailers.

bool isPPP (  )  const throw () [inline]

Test if the interface is a PPP interface.

bool isPromiscuous (  )  const throw () [inline]

Test if the interface is in promiscuous mode.

bool isRunning (  )  const throw () [inline]

Test if the interface is running.

bool isUp (  )  const throw () [inline]

Test if the interface is up.


Friends And Related Function Documentation

friend class Network [friend]


Member Data Documentation

const uint32_t FLAG_BROADCAST = 0x0002 [static]

A flag indicating that an interface has broadcast capability.

const uint32_t FLAG_DEBUG = 0x0004 [static]

A flag indicating that an interface has debugging enabled.

const uint32_t FLAG_LOOPBACK = 0x0008 [static]

A flag identifying an interface as a loopback interface.

const uint32_t FLAG_MASK = 0x03FF [static]

Flag mask (all flag bits set).

const uint32_t FLAG_MULTICAST = 0x0200 [static]

A flag indicating that an interface has multicast capability.

const uint32_t FLAG_NOARP = 0x0080 [static]

A flag indicating that an interface rejects Address Resolution Protocol (ARP) requests.

const uint32_t FLAG_NOTRAILERS = 0x0020 [static]

A flag indicating that an interface does not use trailers.

const uint32_t FLAG_PPP = 0x0010 [static]

A flag identifying an interface as a Point-to-Point link interface.

const uint32_t FLAG_PROMISCUOUS = 0x0100 [static]

A flag indicating that an interface is in promiscuous mode.

const uint32_t FLAG_RUNNING = 0x0040 [static]

A flag indicating that an interface is running.

const uint32_t FLAG_UP = 0x0001 [static]

A flag indicating that an interface is up.


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

Generated on Sat Apr 17 23:03:09 2010 for libcommonc++ by  doxygen 1.5.9