This interface is used to query and change the general configuration. More...
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... |
|
Additional Inherited Members | |
Public Types inherited from mi::base::Interface_declare< 0x4df9426f, 0xaab5, 0x4453, 0xbd, 0x53, 0xc1, 0xfb, 0x0d, 0x82, 0xf9, 0x7f > | |
typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IInterface > |
Self |
Own type. More... |
|
typedef Uuid_t< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11 > |
IID |
Declares the interface ID (IID) of this interface. More... |
|
Static Public Member Functions inherited from mi::base::Interface_declare< 0x4df9426f, 0xaab5, 0x4453, 0xbd, 0x53, 0xc1, 0xfb, 0x0d, 0x82, 0xf9, 0x7f > | |
static bool | compare_iid (const Uuid &iid) |
Compares the interface ID iid against the interface ID of this interface and of its ancestors. More... |
|
This interface is used to query and change the general configuration.
|
pure virtual |
Returns the host properties for this host.
Host properties are only available while Iray is running.
NULL
on error.
|
pure virtual |
Gets the HTTP proxy address for WebSocket.
NULL
is returned.
|
pure virtual |
Gets username for authentication with the HTTP proxy address for WebSocket.
NULL
is returned.
|
pure virtual |
Returns the path for temporary files.
|
pure virtual |
Sets the address of the administrative HTTP server.
Iray 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 Iray 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 Iray has been started.
listen_address | The address and port to listen on. NULL disables the server. |
|
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.
key | The key for the property. |
value | The property value. |
|
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.
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" . |
|
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.
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. |
|
pure virtual |
Sets the path for temporary files.
This can only be configured before Iray has been started.
path | The path to be set. |