ToiNetConfiguration Interface Reference

---

Description

Technical Preview:

This interface is a TECHNICAL PREVIEW, it may change.

ToiNetConfiguration is used to get information about available network devices.

import "ToiNetConfiguration.idl";

Inheritance diagram for ToiNetConfiguration:

List of all members.

Public Member Functions
TToiNetDeviceDescriptorSequence	getNetworkDevices ()
ToiNetIpDevice	getIpDevice (in TToiNetDeviceId id) raises (TToiInvalidArgumentException)
ToiNetMocaDevice	getMocaDevice (in TToiNetDeviceId id) raises (TToiInvalidArgumentException, TToiOperationNotSupportedException)
Public Attributes
TToiNetDeviceType
const TToiNetDeviceType	NET_DEVICE_TYPE_ETHERNET = 0
const TToiNetDeviceType	NET_DEVICE_TYPE_MOCA = 1
Public Types
typedef long	TToiNetDeviceId
typedef long	TToiNetDeviceType
typedef sequence < ToiNetConfigurationNetDeviceDescriptor >	TToiNetDeviceDescriptorSequence

---

Member Typedef Documentation

typedef sequence< ToiNetConfigurationNetDeviceDescriptor > ToiNetConfiguration::TToiNetDeviceDescriptorSequence

List of descriptors of network devices.

typedef long ToiNetConfiguration::TToiNetDeviceId

Network device identifier type.

typedef long ToiNetConfiguration::TToiNetDeviceType

The type of the network interface.

---

Member Function Documentation

ToiNetIpDevice ToiNetConfiguration::getIpDevice

(

in TToiNetDeviceId

id

)

raises (TToiInvalidArgumentException)

Returns the network device.

Parameters:

id	The network device identifier.

Return values:

IToiNetIpDevice

Exceptions:

TToiInvalidArgumentException

Raised if the network device identifier is invalid.

ToiNetMocaDevice ToiNetConfiguration::getMocaDevice

(

in TToiNetDeviceId

id

)

raises (TToiInvalidArgumentException, TToiOperationNotSupportedException)

Returns the MoCA device.

Parameters:

id	The network device identifier.

Return values:

IToiNetMocaDevice

Exceptions:

TToiInvalidArgumentException	Raised if the network device identifier is invalid.
TToiOperationNotSupportedException	Raised if the MoCA device is not supported.

TToiNetDeviceDescriptorSequence ToiNetConfiguration::getNetworkDevices

(

)

Returns available network devices.

Return values:

networkDeviceList

The list available network devices.

---

Member Data Documentation

const TToiNetDeviceType ToiNetConfiguration::NET_DEVICE_TYPE_ETHERNET = 0

The type is ethernet.

This constant can also be accessed from toi.consts.ToiNetConfiguration.NET_DEVICE_TYPE_ETHERNET.

const TToiNetDeviceType ToiNetConfiguration::NET_DEVICE_TYPE_MOCA = 1

The type is moca.

This constant can also be accessed from toi.consts.ToiNetConfiguration.NET_DEVICE_TYPE_MOCA.