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
TToiNetDeviceIdSequence	getNetworkDevices (in long typeMask) raises (TToiInvalidArgumentException)
ToiNetConfigurationNetDeviceInfo	getGenericDeviceInfo (in TToiNetDeviceId id) raises (TToiInvalidArgumentException)
ToiNetIpDevice	getIpDevice (in TToiNetDeviceId id) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)
ToiNetEthernetDevice	getEthernetDevice (in TToiNetDeviceId id) raises (TToiInvalidArgumentException, TToiOperationNotSupportedException, TToiInvalidPreconditionException)
ToiNetMocaDevice	getMocaDevice (in TToiNetDeviceId id) raises (TToiInvalidArgumentException, TToiOperationNotSupportedException, TToiInvalidPreconditionException)
Public Attributes
TToiNetDeviceType
const TToiNetDeviceType	NET_DEVICE_TYPE_ETHERNET = 0x1
const TToiNetDeviceType	NET_DEVICE_TYPE_MOCA = 0x2
const TToiNetDeviceType	NET_DEVICE_TYPE_ESTB = 0x4
const TToiNetDeviceType	NET_DEVICE_TYPE_ALL = 0xff
Public Types
typedef long	TToiNetDeviceId
typedef sequence< TToiNetDeviceId >	TToiNetDeviceIdSequence
typedef long	TToiNetDeviceType

---

Member Typedef Documentation

typedef long ToiNetConfiguration::TToiNetDeviceId

Network device identifier type.

typedef sequence< TToiNetDeviceId > ToiNetConfiguration::TToiNetDeviceIdSequence

List of identifiers of network devices.

typedef long ToiNetConfiguration::TToiNetDeviceType

Bit mask values indicating the type of the network device.

---

Member Function Documentation

ToiNetEthernetDevice ToiNetConfiguration::getEthernetDevice

(

in TToiNetDeviceId

id

)

raises (TToiInvalidArgumentException, TToiOperationNotSupportedException, TToiInvalidPreconditionException)

Returns the Ethernet device.

Parameters:

id	The network device identifier.

Return values:

IToiNetEthernetDevice
address	The ToiNetEthernetDevice address.

Exceptions:

TToiInvalidArgumentException	Raised if the network device identifier is invalid.
TToiOperationNotSupportedException	Raised if the Ethernet device is not supported.
TToiInvalidPreconditionException	Raised if the Ethernet device is not initialized.

ToiNetConfigurationNetDeviceInfo ToiNetConfiguration::getGenericDeviceInfo

(

in TToiNetDeviceId

id

)

raises (TToiInvalidArgumentException)

Returns the generic network device info.

Parameters:

id	The network device identifier.

Return values:

info	The network device info.

Exceptions:

TToiInvalidArgumentException

Raised if the network device identifier is invalid.

ToiNetIpDevice ToiNetConfiguration::getIpDevice

(

in TToiNetDeviceId

id

)

raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)

Returns the base IpDevice corresponding to the specified device id.

Parameters:

id	The network device identifier.

Return values:

IToiNetIpDevice
address	The ToiNetIpDevice address.

Exceptions:

TToiInvalidArgumentException	Raised if the network device identifier is invalid.
TToiInvalidPreconditionException	Raised if the device is not initialized.

ToiNetMocaDevice ToiNetConfiguration::getMocaDevice

(

in TToiNetDeviceId

id

)

raises (TToiInvalidArgumentException, TToiOperationNotSupportedException, TToiInvalidPreconditionException)

Returns the MoCA device.

Parameters:

id	The network device identifier.

Return values:

IToiNetMocaDevice
address	The ToiNetMocaDevice address.

Exceptions:

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

TToiNetDeviceIdSequence ToiNetConfiguration::getNetworkDevices

(

in long

typeMask

)

raises (TToiInvalidArgumentException)

Returns available network devices of specified types.

Parameters:

typeMask

The bit mask of types of the network devices as defined by ToiNetConfiguration::TToiNetDeviceType.

Return values:

identifiers

Identifiers of the available network devices.

Exceptions:

TToiInvalidArgumentException

Raised if the bit mask of types of the network devices is invalid.

---

Member Data Documentation

const TToiNetDeviceType ToiNetConfiguration::NET_DEVICE_TYPE_ALL = 0xff

All types of the devices.

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

const TToiNetDeviceType ToiNetConfiguration::NET_DEVICE_TYPE_ESTB = 0x4

The type is an embedded settop (eSTB) interface to a DOCSIS device.

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

const TToiNetDeviceType ToiNetConfiguration::NET_DEVICE_TYPE_ETHERNET = 0x1

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 = 0x2

The type is moca.

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