Member Functions

virtual IIray_bridge_snapshot_context* mi::​bridge::​IIray_bridge_client::create_snapshot_context( neuraylib::​ITransaction* transaction, const char* scene_name) [pure virtual]

Creates a snapshot context.

Parameters

transaction

The transaction determines the scope of the context. All transactions used with the context need to be from the same scope.

scene_name

The scene of the context.

Returns

A snapshot context for the given scope and scene, or NULL if creation failed.

virtual const char* mi::​bridge::​IIray_bridge_client::get_application_url() const [pure virtual]

Returns the configured Iray Bridge application URL.

virtual const char* mi::​bridge::​IIray_bridge_client::get_bridge_protocol_version() const [pure virtual]

Returns the Iray Bridge protocol version.

virtual base::​Message_severity mi::​bridge::​IIray_bridge_client::get_log_forwarding_level() const [pure virtual]

Returns the currently set log level for messages forwarded from the Iray Bridge server.

See also:

set_log_forwarding_level

Returns

The current log forwarding level.

virtual base::​ILogger* mi::​bridge::​IIray_bridge_client::get_receiving_logger() const [pure virtual]

Returns the receiving logger for log messages forwarded from the Iray Bridge server. Note that if no receiving logger has been set, this method returns NULL and logging is done using the currently general configured logger.

See also:

set_receiving_logger()

Returns

The current receiving logger.

virtual const char* mi::​bridge::​IIray_bridge_client::get_security_token() const [pure virtual]

Returns the configured security token.

virtual Sint32 mi::​bridge::​IIray_bridge_client::set_application_url( const char* application_url) [pure virtual]

Sets the web socket URL to the server-side Iray Bridge application. Bridge renderer contexts and snapshot contexts will use this address when connecting to the Iray Bridge server application and will also detect changes and reconnect to the new server automatically.

See also:

mi::bridge::IIray_bridge_server::create_application()

Parameters

application_url

The web socket URL to the server-side Iray Bridge application. If the HTTP server listens on host "somehost" and port 80, and the application path on the server side is set to "/myapp", then the client will connect using the URL "ws://somehost:80/myapp". If the connection is encrypted using the SSL protocol, then the prefix "wss" needs to be used instead of "ws". Note that the port must be specified. The standard port for web sockets is 80 and 443 for secure web sockets. Iray Bridge server instances running on the VCA use SSL, run on port 443, and use the application path "/bridge".

Returns

0 on success, <0 for unspecified error.

virtual Sint32 mi::​bridge::​IIray_bridge_client::set_log_forwarding_level( base::​Message_severity level) [pure virtual]

Sets the log level of messages that are forwarded from the Iray Bridge server. Note that this does not affect the log level of the server, nor the log level of the client. It only filters the messages forwarded by the server to the client.

See also:

get_log_forwarding_level()

Returns

0 on success, <0 for unspecified error.

virtual void mi::​bridge::​IIray_bridge_client::set_receiving_logger( base::​ILogger* logger) [pure virtual]

Sets the receiving logger for log messages forwarded from the Iray Bridge server. If the provided logger is NULL then forwarded log entries will be written to the general configured logger as if they were generated locally, but with a prefix identifying the server that they originated from (default behavior).

See also:

set_receiving_logger()

Parameters

logger

The receiving logger. It is valid to pass NULL in which case logging is reset to be done to the general configured logger.

virtual Sint32 mi::​bridge::​IIray_bridge_client::set_security_token( const char* security_token) [pure virtual]

Sets the security token to use when connecting the server-side Iray Bridge application.

Returns

0 on success, <0 for unspecified error.