IDeviceNetworkConfig Struct Reference

Interface for managing device network configuration information and settings. More...

Inheritance diagram for IDeviceNetworkConfig:

Collaboration diagram for IDeviceNetworkConfig:

Detailed Description

Interface for managing device network configuration information and settings.

The interface is typically used by the discovery server, if present, to obtain the necessary information for advertising the device's network configuration capabilities and handling related requests.

The device must be designated as the root device to enable the use of this interface's methods.

Public Member Functions
virtual ErrCode INTERFACE_FUNC	submitNetworkConfiguration (IString *ifaceName, IPropertyObject *config)=0
	Submits a new configuration parameters to a specified network interface. More...
virtual ErrCode INTERFACE_FUNC	retrieveNetworkConfiguration (IString *ifaceName, IPropertyObject **config)=0
	Retrieves the currently active configuration of a specified network interface. More...
virtual ErrCode INTERFACE_FUNC	getNetworkConfigurationEnabled (Bool *enabled)=0
	Checks if the device supports network configuration management. More...
virtual ErrCode INTERFACE_FUNC	getNetworkInterfaceNames (IList **ifaceNames)=0
	Gets the names of all configurable network interfaces on the device. More...
Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC	borrowInterface (const IntfID &intfID, void **obj) const =0
	Returns another interface which is supported by the object without incrementing the reference count. More...
virtual ErrCode INTERFACE_FUNC	dispose ()=0
	Disposes all references held by the object. More...
virtual ErrCode INTERFACE_FUNC	getHashCode (SizeT *hashCode)=0
	Returns hash code of the object. More...
virtual ErrCode INTERFACE_FUNC	equals (IBaseObject *other, Bool *equal) const =0
	Compares object to another object for equality. More...
virtual ErrCode INTERFACE_FUNC	toString (CharPtr *str)=0
	Returns a string representation of the object. More...
Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC	queryInterface (const IntfID &intfID, void **obj)=0
	Returns another interface which is supported by the object and increments the reference count. More...
virtual int INTERFACE_FUNC	addRef ()=0
	Increments the reference count for an interface on an object. More...
virtual int INTERFACE_FUNC	releaseRef ()=0
	Decrements the reference count for an interface on an object. More...

Member Function Documentation

getNetworkConfigurationEnabled()

virtual ErrCode INTERFACE_FUNC getNetworkConfigurationEnabled ( Bool *  enabled )

pure virtual

Checks if the device supports network configuration management.

Parameters

[out]

enabled

A flag indicating whether the device supports managing network configurations.

getNetworkInterfaceNames()

virtual ErrCode INTERFACE_FUNC getNetworkInterfaceNames ( IList **  ifaceNames )

pure virtual

Gets the names of all configurable network interfaces on the device.

Parameters

[out]

ifaceNames

A list containing the names of network interface adapters available for configuration.

Return values

OPENDAQ_ERR_NOTIMPLEMENTED

if the device does not support network configuration management.

retrieveNetworkConfiguration()

virtual ErrCode INTERFACE_FUNC retrieveNetworkConfiguration ( IString *  ifaceName, IPropertyObject **  config  )

pure virtual

Retrieves the currently active configuration of a specified network interface.

Parameters

	ifaceName	The name of the network interface adapter as registered in the operating system. Typically, this is a short symbolic identifier for the adapter, e.g. "eth0".
[out]	config	The property object containing the active configuration of the network interface.

Return values

OPENDAQ_ERR_NOTIMPLEMENTED

if the device does not support retrieving network configurations.

submitNetworkConfiguration()

virtual ErrCode INTERFACE_FUNC submitNetworkConfiguration ( IString *  ifaceName, IPropertyObject *  config  )

pure virtual

Submits a new configuration parameters to a specified network interface.

Parameters

ifaceName	The name of the network interface adapter as registered in the operating system. Typically, this is a short symbolic identifier for the adapter, e.g. "eth0".
config	The property object with new configuration parameters to submit. The format of the properties matches that used in INetworkInterface.

Return values

OPENDAQ_ERR_NOTIMPLEMENTED

if the device does not support network configuration management.