Member Functions

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 is running.

Returns

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

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.

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.

virtual const char* mi::​neuraylib::​IGeneral_configuration::get_temp_path() const [pure virtual]

Returns the path for temporary files.

Returns

The currently configured path.

virtual Sint32 mi::​neuraylib::​IGeneral_configuration::set_admin_http_address( const char* listen_address) [pure virtual]

Sets the address of the administrative HTTP server. 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 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 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.

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.

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.

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.

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 has been started.

Parameters

path

The path to be set.

Returns

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