DeviceNetworkConfigPtr Class Reference

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

Inherits ObjectPtr< 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
void	submitNetworkConfiguration (const daq::StringPtr &ifaceName, const daq::PropertyObjectPtr &config) const
	Submits a new configuration parameters to a specified network interface. More...
daq::PropertyObjectPtr	retrieveNetworkConfiguration (const daq::StringPtr &ifaceName) const
	Retrieves the currently active configuration of a specified network interface. More...
daq::Bool	getNetworkConfigurationEnabled () const
	Checks if the device supports network configuration management. More...
daq::ListPtr< daq::IString >	getNetworkInterfaceNames () const
	Gets the names of all configurable network interfaces on the device. More...

Member Function Documentation

getNetworkConfigurationEnabled()

daq::Bool getNetworkConfigurationEnabled ( ) const

inline

Checks if the device supports network configuration management.

Returns

A flag indicating whether the device supports managing network configurations.

getNetworkInterfaceNames()

daq::ListPtr<daq::IString> getNetworkInterfaceNames ( ) const

inline

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

Returns

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

Exceptions

NotImplementedException

if the device does not support network configuration management.

retrieveNetworkConfiguration()

daq::PropertyObjectPtr retrieveNetworkConfiguration ( const daq::StringPtr &  ifaceName ) const

inline

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".

Returns

The property object containing the active configuration of the network interface.

Exceptions

NotImplementedException

if the device does not support retrieving network configurations.

submitNetworkConfiguration()

void submitNetworkConfiguration ( const daq::StringPtr &  ifaceName, const daq::PropertyObjectPtr &  config  ) const

inline

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.

Exceptions

NotImplementedException

if the device does not support network configuration management.