mi::bridge::IBridge_server Class Reference

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

Inheritance diagram for mi::bridge::IBridge_server:

Public Member Functions
virtual IApplication *	create_application (const char *application_path, http::IServer *http_server)=0
	Creates a Bridge application. More...
virtual IBridge_snapshot_context *	create_snapshot_context (const char *disk_cache)=0
	Creates a snapshot context for importing or deleting snapshots. More...
virtual const char *	get_bridge_protocol_version () const =0
	Returns the Bridge protocol version string. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x1fd8a3ac, 0xa70c, 0x4273, 0xa9, 0x1a, 0x67, 0x57, 0xdf, 0xc7, 0xa5, 0xb >
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< 0x1fd8a3ac, 0xa70c, 0x4273, 0xa9, 0x1a, 0x67, 0x57, 0xdf, 0xc7, 0xa5, 0xb >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...

Detailed Description

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

Can be used to create Bridge application and a context to import or remove snapshots.

Member Function Documentation

virtual IApplication* mi::bridge::IBridge_server::create_application ( const char *  application_path, http::IServer *  http_server  )

pure virtual

Creates a Bridge application.

The application will listen on the provided path on the given HTTP server for clients. The application has to be opened for connections before clients can open a session to it.

See Also

mi::bridge::IBridge_client::get_session()

Parameters

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

Returns

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

virtual IBridge_snapshot_context* mi::bridge::IBridge_server::create_snapshot_context ( const char *  disk_cache)

pure virtual

Creates a snapshot context for importing or deleting snapshots.

See Also

mi::bridge::IServer_transaction::create_snapshot(), mi::bridge::IServer_transaction::create_incremental_snapshot_context()

Parameters

disk_cache

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

The snapshot context.

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

pure virtual

Returns the Bridge protocol version string.