ToiNetConfigurationSession Interface Reference

---

Description

Technical Preview:

This interface is a TECHNICAL PREVIEW, it may change.

ToiNetConfigurationSession is used to change the parameters of available network devices.

import "ToiNetConfigurationSession.idl";

Inheritance diagram for ToiNetConfigurationSession:

List of all members.

Public Member Functions
ToiOperationManager	getOperationManager ()
void	setInitialized (in ToiOperationManager::TToiOperationId operationId, in ToiNetConfiguration::TToiNetDeviceId deviceId, in boolean doInitialize) raises (TToiInvalidArgumentException)
void	revert () raises (TToiOperationNotSupportedException)
void	clear ()
void	clearDevice (in ToiNetConfiguration::TToiNetDeviceId deviceId) raises (TToiInvalidArgumentException)
void	apply () raises (TToiOperationNotSupportedException)
void	releaseInstance ()

---

Member Function Documentation

void ToiNetConfigurationSession::apply

(

)

raises (TToiOperationNotSupportedException)

Applies the changes made in the configuration session and makes the changes permanent as well as notifying any observers of the changed configuration.

Exceptions:

TToiOperationNotSupportedException

Raised if apply cannot be performed.

void ToiNetConfigurationSession::clear

(

)

Clears this configuration session to default settings for all devices. The cleared configuration is not applied until ToiNetConfigurationSession::apply() is called.

void ToiNetConfigurationSession::clearDevice

(

in ToiNetConfiguration::TToiNetDeviceId

deviceId

)

raises (TToiInvalidArgumentException)

Clears the specified device to its default settings. The cleared configuration is not applied until ToiNetConfigurationSession::apply() is called.

Parameters:

deviceId

The Network device identifier.

Exceptions:

TToiInvalidArgumentException

Raised if device identifier is invalid.

ToiOperationManager ToiNetConfigurationSession::getOperationManager

(

)

Returns the operation manager that handles asynchronous operations involving Net operations. The procedure of executing asynchronous operations is generic and looks like this:

• Get a handle to the operation manager.
• Register an observer to get operation events from the operation manager.
• Create an operation in order to get an operation identifier.
• Call an asynchronous operation using the operation identifier.
• Receive progress events for the asynchronous operation.
• When the operation is completed, get result data (if any).
• Release the operation or reuse the identifier for another asynchronous call.

Return values:

IToiOperationManager

void ToiNetConfigurationSession::releaseInstance

(

)

This function releases the resources used by this instance and ends the configuration session. If ToiNetConfigurationSession::apply() has not been called, the session configuration is lost. When this function returns all observers has also been released.

void ToiNetConfigurationSession::revert

(

)

raises (TToiOperationNotSupportedException)

Reverts a configuration session to the state it had when first being created, even if changes have been applied. The reverted configuration is not applied until ToiNetConfigurationSession::apply() is called.

Exceptions:

TToiOperationNotSupportedException

Raised if a revert cannot be performed.

void ToiNetConfigurationSession::setInitialized	(	in ToiOperationManager::TToiOperationId	operationId,
		in ToiNetConfiguration::TToiNetDeviceId	deviceId,
		in boolean	doInitialize
	)		raises (TToiInvalidArgumentException)

Initializes/uninitializes the network device. This is an asynchronous operation.

The application receives a ToiOperationOperationResultEvent call with the operation result ToiOperationManager::OP_RESULT_NONE and the operation state ToiOperationManager::OPERATION_COMPLETED when the device was successfully initialized/uninitialized as requested.

Parameters:

operationId	The operation identifier created by ToiOperationManager.
deviceId	The Network device identifier.
doInitialize	Initialize/uninitialize flag.

Exceptions:

TToiInvalidArgumentException

Raised if device identifier is invalid, or raised if the operation identifier is illegal.