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
boolIsLoopback ( ) const
voidSetDescription ( 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

Default constructor.

public RNET::Adapter::Adapter(const RNET::Address &iAddress,
const RNET::Address &iBroadcastAdress,
const RED::String &iDescription,
booliLoopback
)

Constructor.

Parameters:

iAddressaddress of the adapter.
iBroadcastAdressbroadcast address of the adapter.
iDescriptiondescription of the adapter.
iLoopbacktrue if the adapter is a loopback interface, false otherwise.

Destructor.

Returns:

the address of the adapter.

Returns:

the broadcast address of the adapter.

Returns:

the adapter description.
public bool RNET::Adapter::IsLoopback() const

Returns:

true if the adapter is a loopback interface, false otherwise.
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.