mi::bridge::IIray_bridge_server Class Reference

API component that serves as entry point for the server-side Iray Bridge API. More...

#include <iiray_bridge_server.h>

Inheritance diagram for mi::bridge::IIray_bridge_server:

Public Member Functions
virtual IIray_bridge_application *	create_application (const char *application_path, http::IServer *http_server)=0
	Creates an Iray Bridge application. More...
virtual const char *	get_bridge_protocol_version () const =0
	Returns the Bridge protocol version. More...
virtual Sint32	delete_snapshot (const char *snapshot_path)=0
	Deletes a bridge snapshot specified by the provided path to a .cb file on disk. More...
virtual Sint32	delete_snapshot_from_string (const char *cb_data)=0
	Deletes a bridge snapshot specified by the provided cb file contents stored as a string. 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< 0x1acd50a4, ... >
using	Self = Interface_declare< id1, ... >
	Own type. More...
using	IID = Uuid_t< id1, ... >
	Declares the interface ID (IID) of this interface. More...
Public Types inherited from mi::base::IInterface
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 Public Member Functions inherited from mi::base::Interface_declare< 0x1acd50a4, ... >
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

API component that serves as entry point for the server-side Iray Bridge API.

This API component is provided by the iray_bridge_server plugin.

Member Function Documentation

create_application()

virtual IIray_bridge_application * mi::bridge::IIray_bridge_server::create_application ( const char *  application_path, http::IServer *  http_server  )

pure virtual

Creates an Iray Bridge application.

The Iray Bridge application instance provides the server-side features of Iray Bridge rendering.

See also

mi::bridge::IIray_bridge_client::set_application_url()

Parameters

application_path	The path component of the WebSocket URL to the application. This identifier allows to run different Iray Bridge applications on the same HTTP server. Note that the application path must start with a slash.
http_server	The HTTP server instance that handles WebSocket requests for this application.

Returns

The created Iray Bridge application, or nullptr in case of failure (invalid arguments, application_path does not start with a slash, or an application for these arguments exists already).

delete_snapshot()

virtual Sint32 mi::bridge::IIray_bridge_server::delete_snapshot ( const char *  snapshot_path )

pure virtual

Deletes a bridge snapshot specified by the provided path to a .cb file on disk.

Note that the disk cache referenced by the snapshot must be reachable for the snapshot to be successfully deleted.

Parameters

snapshot_path

The path to the snapshot .cb file to delete.

Returns

• 0: Success.
• -1: Invalid argument.
• -2: The snapshot file was not found or inaccessible.
• -3: Failed to remove the cached data for the snapshot.
• -4: Failed to delete the snapshot file.
• <= -5: Unspecified error.

See also

mi::bridge::IIray_bridge_snapshot_context

delete_snapshot_from_string()

virtual Sint32 mi::bridge::IIray_bridge_server::delete_snapshot_from_string ( const char *  cb_data )

pure virtual

Deletes a bridge snapshot specified by the provided cb file contents stored as a string.

This method works the same as delete_snapshot() but covers the case when the cb file contents is not stored in a .cb file on disk. Note that the disk cache referenced by the snapshot must be reachable for the snapshot to be successfully deleted.

Parameters

cb_data

The cb data as a char buffer.

Returns

• 0: Success.
• -1: Invalid argument.
• -2: Failed to remove the cached data for the snapshot.
• <= -3: Unspecified error.

See also

mi::bridge::IIray_bridge_snapshot_context

get_bridge_protocol_version()

virtual const char * mi::bridge::IIray_bridge_server::get_bridge_protocol_version ( ) const

pure virtual

Returns the Bridge protocol version.