class RNET::Adapter
This class defines a network adapter. More...
#include <RNETAdapter.h>
Inherits: Object.
Public functions:
Adapter ( ) | |
Adapter ( const RNET::Address & iAddress, const RNET::Address & iBroadcastAdress, const RED::String & iDescription, bool iLoopback ) | |
~Adapter ( ) | |
const RNET::Address & | GetAddress ( ) const |
const RNET::Address & | GetBroadcastAddress ( ) const |
const RED::String & | GetDescription ( ) const |
bool | IsLoopback ( ) const |
void | SetDescription ( const RED::String & iDescription ) |
Protected variables:
RNET::Address | _address |
RNET::Address | _address_broadcast |
RED::String | _desc |
bool | _loopback |
Detailed description:
This class defines a network adapter.
It stores the network address of the adapter along with a plain text description. This class is needed by REDnet to handle multiple network adapters configurations.
A full list of the available network adapters on the machine is returned by the call to RNET::System::Initialize. The adapter to use can be explicitely set by calling RNET::System::SetAdapter.
Functions documentation
public RNET::Adapter::Adapter | ( | ) |
Default constructor.
public RNET::Adapter::Adapter | ( | const RNET::Address & | iAddress, |
const RNET::Address & | iBroadcastAdress, | ||
const RED::String & | iDescription, | ||
bool | iLoopback | ||
) |
Constructor.
Parameters:
iAddress | address of the adapter. |
iBroadcastAdress | broadcast address of the adapter. |
iDescription | description of the adapter. |
iLoopback | true if the adapter is a loopback interface, false otherwise. |
public RNET::Adapter::~Adapter | ( | ) |
Destructor.
public const RNET::Address & RNET::Adapter::GetAddress | ( | ) const |
Returns:
public const RNET::Address & RNET::Adapter::GetBroadcastAddress | ( | ) const |
Returns:
public const RED::String & RNET::Adapter::GetDescription | ( | ) const |
Returns:
public bool RNET::Adapter::IsLoopback | ( | ) const |
Returns:
public void RNET::Adapter::SetDescription | ( | const RED::String & | iDescription | ) |
Sets the adapter description.
Variables documentation
address of the adapter.
broadcast address of the adapter.
description of the adapter.
true if the adapter is a loopback interface, false otherwise.