The Iray Bridge application.
More...
#include <iiray_bridge_server.h>
|
| using | Self = Interface_declare< id1, ... > |
| | Own type. More...
|
| |
| using | IID = Uuid_t< id1, ... > |
| | Declares the interface ID (IID) of this interface. More...
|
| |
| using | IID = Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0> |
| | Declares the interface ID (IID) of this interface. More...
|
| |
| 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 bool | compare_iid (const Uuid &iid) |
| | Compares the interface ID iid against the interface ID of this interface. More...
|
| |
The Iray Bridge application.
This application is installed by the iray_bridge_server plugin and provides the server-side features of Iray Bridge rendering.
- See also
- mi::bridge::IIray_bridge_server::create_application()
◆ close()
| virtual Sint32 mi::bridge::IIray_bridge_application::close |
( |
| ) |
|
|
pure virtual |
Closes the application and any open sessions.
- Returns
- 0: Success.
- -1: The application is already closed.
- <= -2: Unspecified error.
◆ get_disk_cache()
| virtual const char * mi::bridge::IIray_bridge_application::get_disk_cache |
( |
| ) |
const |
|
pure virtual |
◆ get_log_forwarding_limit()
Returns the maximum verbosity of log messages that will be forwarded to the client.
- See also
- set_log_forwarding_limit()
- Returns
- The current log forwarding limit
◆ get_session_handler()
Returns the current session handler, or nullptr if no session handler has been set.
◆ get_snapshot_path()
| virtual const char * mi::bridge::IIray_bridge_application::get_snapshot_path |
( |
| ) |
const |
|
pure virtual |
Returns the currently configured snapshot path.
◆ open()
| virtual Sint32 mi::bridge::IIray_bridge_application::open |
( |
bool |
enable_streaming = true | ) |
|
|
pure virtual |
Opens the application so that clients can open sessions to it.
- Parameters
-
| enable_streaming | Configure if the bridge supports only snapshots or streaming as well. |
- Returns
- 0: Success
- -1: Mandatory configuration is incomplete (
- See also
- set_disk_cache()).
- -2: The application is already open.
- <= -3: Unspecified error.
◆ set_disk_cache()
| virtual Sint32 mi::bridge::IIray_bridge_application::set_disk_cache |
( |
const char * |
location | ) |
|
|
pure virtual |
Sets the disk cache to use.
- Note
- The disk cache must be set before the application can be opened for client sessions. The disk cache can not be changed after it has been successfully set.
- See also
- get_disk_cache(), mi::neuraylib::ICache_manager_factory
- Parameters
-
| location | The location of the disk cache. This can be either a directory on the local machine (prefix "path:") or the address of some cache manager (prefix "address:"). |
- Returns
- 0: Success.
- -1: Invalid argument (
disk_cache is nullptr or has an incorrect format).
- -2: No disk cache found at the specified location.
- -3: The disk cache was already set.
- <= -4: Unspecified error.
◆ set_log_forwarding_limit()
Sets the maximum verbosity of log messages that will be forwarded to the client.
Note that the log level that will be forwarded is requested by the client, and this setting will only override the client request in case the server needs to restrict logging further, for instance because of security considerations. So if the client requests that info level messages and more severe will be forwarded and the server sets the limit to warning severity, then only warning log messages will be forwarded.
Defaults to mi::base::details::MESSAGE_SEVERITY_DEBUG which will allow the client to request forwarding of all log messages. Set to mi::base::details::MESSAGE_SEVERITY_FATAL to turn of log forwarding.
- See also
- get_log_forwarding_limit()
- Parameters
-
| limit | The log message limit to set. |
- Returns
- 0 on success, <0 for unspecified error.
◆ set_session_handler()
Sets the session handler that will be called when clients connect.
The session handler will be called as part of the handshake between client and server to decide weather to accept or to reject the client, e.g., based on a security token supplied by the client. The server will always accept clients if no session handler is set (default behavior). The session handler can also be used to keep track of which sessions are connected to the application and their state by adding an mi::bridge::IServer_session_state_callback to the session.
- Parameters
-
| handler | The handler to be set or nullptr to remove the current handler. |
- Returns
- 0 on success, <0 for unspecified error.
◆ set_snapshot_handler()
Configure the application with the snapshot handler to use.
The handler can decide if a request to create a snapshot is allowed based on the session and also decides how the snapshot cb file data is save. The default handler allows all snapshots and stores it as a .cb file in the path configured by calling set_snapshot_path(). Only a single snapshot callback can be installed at a given time, any previous handler will be removed. This method can only be called while the application is closed.
- Parameters
-
| handler | The snapshot handler to install, or 0 to install the default handler. |
- Returns
- 0 Success.
- -1 If the application is open.
- <-1 Unspecified error.
◆ set_snapshot_path()
| virtual Sint32 mi::bridge::IIray_bridge_application::set_snapshot_path |
( |
const char * |
path | ) |
|
|
pure virtual |
Sets the path to which snapshot files will be saved.
- Returns
- 0: Success.
- -1: Invalid argument (
path is nullptr).
- -2: The path is not valid.
- <= -3: Unspecified error.
Public Member Functions inherited from mi::base::IInterface