This interface is used to query and change the general configuration. More...

#include <igeneral_configuration.h>

Inheritance diagram for mi::neuraylib::IGeneral_configuration:

Public Member Functions
virtual Sint32	set_admin_http_address (const char *listen_address)=0
	Sets the address of the administrative HTTP server. More...

virtual const IHost_properties *	get_host_properties () const =0
	Returns the host properties for this host. More...

virtual Sint32	set_host_property (const char key, const char value)=0
	Sets a host property for this host. More...

virtual Sint32	set_temp_path (const char *path)=0
	Sets the path for temporary files. More...

virtual const char *	get_temp_path () const =0
	Returns the path for temporary files. More...

virtual Sint32	set_http_proxy_address (const char *proxy_address)=0
	Enables or disables the usage of HTTP proxy for WebSocket. More...

virtual const char *	get_http_proxy_address () const =0
	Gets the HTTP proxy address for WebSocket. More...

virtual Sint32	set_http_proxy_authentication (const char username, const char password)=0
	Sets username and password for authentication with the HTTP proxy address for WebSocket. More...

virtual const char *	get_http_proxy_username () const =0
	Gets username for authentication with the HTTP proxy address for WebSocket. More...

Public Member Functions inherited from mi::base::IInterface
virtual Uint32	retain () const =0
	Increments the reference count. More...

virtual Uint32	release () const =0
	Decrements the reference count. More...

virtual const IInterface *	get_interface (const Uuid &interface_id) const =0
	Acquires a const interface from another. More...

template<class T>
const T *	get_interface () const
	Acquires a const interface from another. More...

virtual IInterface *	get_interface (const Uuid &interface_id)=0
	Acquires a mutable interface from another. More...

template<class T>
T *	get_interface ()
	Acquires a mutable interface from another. More...

virtual Uuid	get_iid () const =0
	Returns the interface ID of the most derived interface. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x4df9426f, ... >
typedef Interface_declare< id1, ... >	Self
	Own type. More...

typedef Uuid_t< id1, ... >	IID
	Declares the interface ID (IID) of this interface. More...

Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>	IID
	Declares the interface ID (IID) of this interface. More...

Static Public Member Functions inherited from mi::base::Interface_declare< 0x4df9426f, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID `iid` against the interface ID of this interface and of its ancestors. More...

Static Public Member Functions inherited from mi::base::IInterface
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID `iid` against the interface ID of this interface. More...

Detailed Description

This interface is used to query and change the general configuration.

Member Function Documentation

^◆ get_host_properties()

virtual const IHost_properties * mi::neuraylib::IGeneral_configuration::get_host_properties ( ) const

pure virtual

Returns the host properties for this host.

Host properties are only available while DiCE is running.

Returns: The host properties for this host, or NULL on error.

^◆ get_http_proxy_address()

virtual const char * mi::neuraylib::IGeneral_configuration::get_http_proxy_address ( ) const

pure virtual

Gets the HTTP proxy address for WebSocket.

Returns: The proxy address for WebSocket. If no proxy is used, NULL is returned.

^◆ get_http_proxy_username()

virtual const char * mi::neuraylib::IGeneral_configuration::get_http_proxy_username ( ) const

pure virtual

Gets username for authentication with the HTTP proxy address for WebSocket.

Returns: The username for connecting to the HTTP proxy address. If no username was previously provided, NULL is returned.

^◆ get_temp_path()

virtual const char * mi::neuraylib::IGeneral_configuration::get_temp_path ( ) const

pure virtual

Returns the path for temporary files.

Returns: The currently configured path.

^◆ set_admin_http_address()

virtual Sint32 mi::neuraylib::IGeneral_configuration::set_admin_http_address ( const char * listen_address )

pure virtual

Sets the address of the administrative HTTP server.

DiCE has a built-in administrative HTTP server which can be started. It is meant to be used to monitor the system at runtime. It allows one to inspect aspects of the database of DiCE and thus is useful for debugging integrations. Usually it would not be enabled in customer builds. By default, the administrative HTTP server is disabled.

This can only be configured before DiCE has been started.

Parameters

listen_address The address and port to listen on. NULL disables the server.

Returns: 0, in case of success, -1 in case of failure.

^◆ set_host_property()

virtual Sint32 mi::neuraylib::IGeneral_configuration::set_host_property	(	const char *	key,
		const char *	value
	)

pure virtual

Sets a host property for this host.

The change will be propagated to all other hosts in the cluster. The method only works if networking support is available.

Parameters

key	The key for the property.
value	The property value.

Returns: 0, in case of success, -1 in case of failure.

^◆ set_http_proxy_address()

virtual Sint32 mi::neuraylib::IGeneral_configuration::set_http_proxy_address ( const char * proxy_address )

pure virtual

Enables or disables the usage of HTTP proxy for WebSocket.

In case of enabling, this function also sets the HTTP proxy address for WebSocket.

Parameters

proxy_address If proxy_address is NULL, the usage of HTTP proxy is disabled. Otherwise, this parameter must contain the proxy address and port for WebSocket to use. In this case, the address must have the format "address:port". or "host:port".

Returns: 0, in case of success, -1 in case of failure.

^◆ set_http_proxy_authentication()

virtual Sint32 mi::neuraylib::IGeneral_configuration::set_http_proxy_authentication	(	const char *	username,
		const char *	password
	)

pure virtual

Sets username and password for authentication with the HTTP proxy address for WebSocket.

This method is only needed, if the HTTP proxy requires username and password for authentication.

Parameters

username	The username for connecting to the HTTP proxy address. If this is parameter is `NULL`, no authentication is required for connecting to an HTTP proxy.
password	The password for connecting to the HTTP proxy address. If no password is needed, `NULL` or an empty string must be provided.

Returns: 0, in case of success, -1 in case of failure.

^◆ set_temp_path()

virtual Sint32 mi::neuraylib::IGeneral_configuration::set_temp_path ( const char * path )

pure virtual

Sets the path for temporary files.

This can only be configured before DiCE has been started.

Parameters

path	The path to be set.

Returns: 0, in case of success, -1 in case of failure.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_host_properties()

◆ get_http_proxy_address()

◆ get_http_proxy_username()

◆ get_temp_path()

◆ set_admin_http_address()

◆ set_host_property()

◆ set_http_proxy_address()

◆ set_http_proxy_authentication()

◆ set_temp_path()

^◆ get_host_properties()

^◆ get_http_proxy_address()

^◆ get_http_proxy_username()

^◆ get_temp_path()

^◆ set_admin_http_address()

^◆ set_host_property()

^◆ set_http_proxy_address()

^◆ set_http_proxy_authentication()

^◆ set_temp_path()