SkyGI::NetworkInterface Class Reference

Inheritance diagram for SkyGI::NetworkInterface:[legend]Collaboration diagram for SkyGI::NetworkInterface:[legend]List of all members.

Public Member Functions
	NetworkInterface ()
	~NetworkInterface ()
bool	IsValid ()
bool	SetTo (const String &szInterfaceName)
bool	Refresh ()
bool	Apply ()
IPV4Address	GetIP ()
void	SetIP (const IPV4Address &nIPV4Address)
IPV4Address	GetNetMask ()
void	SetNetMask (const IPV4Address &nIPV4Address)
IPV4Address	GetDefaultGateway ()
void	SetDefaultGateway (const IPV4Address &nIPV4Address)
EthernetAddress	GetEthernetAddress ()
bool	Start ()
bool	Stop ()
bool	IsRunning ()
bool	IsLoopBack ()
NetworkInterfaceLink	GetLink ()
String	GetName ()

---

Detailed Description

Examples:

networkinterface.cpp.

---

Constructor & Destructor Documentation

NetworkInterface::NetworkInterface

(

)

NetworkInterface::~NetworkInterface

(

)

---

Member Function Documentation

bool NetworkInterface::IsValid

(

)

bool NetworkInterface::SetTo

(

const String &

szInterfaceName

)

Set network interface

Description:

Sets a new network interface and calls Refresh()

Parameters:

szInterfaceName

Network interface name, for instance: rtl0

Returns:

true if network interface is valid and Refresh() succedded.

Examples:

networkinterface.cpp.

bool NetworkInterface::Refresh

(

)

Refresh network interface status

Description:

Refreshes network interface status. (e.g. IP Address, Netmask, Flags, etc.)

Returns:

true if network interface status could be read

bool NetworkInterface::Apply

(

)

IPV4Address NetworkInterface::GetIP

(

)

Get IP Address of network interface

Description:

Use Refresh() to actually query current configuration

Examples:

networkinterface.cpp.

void NetworkInterface::SetIP

(

const IPV4Address &

nIPV4Address

)

IPV4Address NetworkInterface::GetNetMask

(

)

Get netmask of network interface

Description:

Use Refresh() to actually query current configuration

Examples:

networkinterface.cpp.

void NetworkInterface::SetNetMask

(

const IPV4Address &

nIPV4Address

)

IPV4Address NetworkInterface::GetDefaultGateway

(

)

Get gateway of network interface

Description:

Use Refresh() to actually query current configuration

Examples:

networkinterface.cpp.

void NetworkInterface::SetDefaultGateway

(

const IPV4Address &

nIPV4Address

)

EthernetAddress NetworkInterface::GetEthernetAddress

(

)

Examples:

networkinterface.cpp.

bool NetworkInterface::Start

(

)

bool NetworkInterface::Stop

(

)

bool NetworkInterface::IsRunning

(

)

Examples:

networkinterface.cpp.

bool NetworkInterface::IsLoopBack

(

)

Examples:

networkinterface.cpp.

NetworkInterfaceLink NetworkInterface::GetLink

(

)

Get link status

Description:

No Refresh() is required to get current link status.

Examples:

networkinterface.cpp.

String NetworkInterface::GetName

(

)

Examples:

networkinterface.cpp.

---