NVIDIA Iray API Home  Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
References in manual:  1 
mi::bridge::IIray_bridge_server Class Referenceabstract
Bridge server

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

Inheritance diagram for mi::bridge::IIray_bridge_server:
Inheritance graph
[legend]

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 scene snapshot created by a client side snapshot context. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x1acd50a4, 0xbc89, 0x4712, 0x97, 0xd, 0x79, 0xf2, 0x99, 0x8b, 0x4, 0x12 >
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< 0x1acd50a4, 0xbc89, 0x4712, 0x97, 0xd, 0x79, 0xf2, 0x99, 0x8b, 0x4, 0x12 >
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 Iray Bridge API.

This API component is provided by the iray_bridge_server plugin.

Member Function Documentation

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 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 start with a slash.
http_server The HTTP server instance that handles web socket requests for this application.
Returns
The created Iray 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 Sint32 mi::bridge::IIray_bridge_server::delete_snapshot ( const char *  snapshot_path)
pure virtual

Deletes a scene snapshot created by a client side snapshot context.

It also releases the data in the disk cache referenced by this snapshot.

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 release the cached data for the snapshot.
  • -4: Failed to delete the snapshot file.
  • <= -5: Unspecified error.
See Also
mi::bridge::IIray_bridge_snapshot_context
virtual const char* mi::bridge::IIray_bridge_server::get_bridge_protocol_version ( ) const
pure virtual

Returns the Bridge protocol version.