NVIDIA Iray SDK API nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Bridge server

The Bridge server is a single remote host that makes its resources available to Bridge clients through a proprietary network protocol over a single TCP/IP connection. More...

Classes

class  mi::bridge::IServer_job
 Represents the server-side part of a job that can be executed by the Bridge server. More...
 
class  mi::bridge::Server_job< i_id1, i_id2, i_id3, i_id4, i_id5, i_id6, i_id7, i_id8, i_id9, i_id10, i_id11, I >
 This mixin class provides a default implementation for some of the methods needed by mi::bridge::IServer_job. More...
 
class  mi::bridge::IServer_job_info
 Provides additional information about a bridge job. More...
 
class  mi::bridge::IServer_job_list
 A list of IServer_job instances. More...
 
class  mi::bridge::IServer_transaction_callback
 Abstract interface for callbacks for transaction commit or abort events. More...
 
class  mi::bridge::IIncremental_snapshot_context
 Context for incremental snapshots. More...
 
class  mi::bridge::IServer_transaction
 Database transactions started on the client will be automatically mirrored to the server and exposed as instances of this class to executing Bridge jobs. More...
 
class  mi::bridge::IServer_session_state_callback
 Abstract interface for callbacks for session state changes. More...
 
class  mi::bridge::IServer_transaction_list
 A list of IServer_transaction instances. More...
 
class  mi::bridge::IServer_session
 Represents the server side of a Bridge session. More...
 
class  mi::bridge::IApplication_session_handler
 Abstract interface that can be used to control which sessions to a Bridge application are established, based on credentials supplied by the client. More...
 
class  mi::bridge::IApplication
 This class represents a Bridge application. More...
 
class  mi::bridge::IBridge_snapshot_context
 Context to import, export, or remove snapshots. More...
 
class  mi::bridge::IBridge_server
 API component that serves as entry point for the server-side Bridge API. More...
 
class  mi::bridge::IServer_video_context
 Server-side video context that generates and encodes video frames for the corresponding client-side video context. More...
 
class  mi::bridge::IVideo_source
 Abstract interface to generate video frames that are transmitted to the corresponding client-side video context. More...
 
class  mi::bridge::IIray_bridge_snapshot_handler
 The IIray_bridge_snapshot_handler can be used to control snapshot creation for an Iray bridge server application. More...
 
class  mi::bridge::IIray_bridge_application
 The Iray Bridge application. More...
 
class  mi::bridge::IIray_bridge_server
 API component that serves as entry point for the server-side Iray Bridge API. More...
 

Enumerations

enum  mi::bridge::Server_session_state {
  mi::bridge::SERVER_SESSION_CONNECTING = 0,
  mi::bridge::SERVER_SESSION_CONNECTED = 1,
  mi::bridge::SERVER_SESSION_PENDING = 2,
  mi::bridge::SERVER_SESSION_CLOSED = 3
}
 The different states a server session can be in. More...
 

Detailed Description

The Bridge server is a single remote host that makes its resources available to Bridge clients through a proprietary network protocol over a single TCP/IP connection.

The client uses the connection to send changes and delegate work to the Bridge server; the server uses the connection to send job results and other data back to the client.

A Bridge server can serve multiple clients at the same time. This is equivalent to starting multiple jobs simultaneously on a host in a normal local cluster.

The API consists of two layers: a low-level API, called Bridge API, and a high-level API, called Iray Bridge API. The low-level Bridge API is generic and independent of domain-specific tasks like rendering. It exposes the full flexibility of the Bridge. The high-level Iray Bridge API is specific to rendering. It encapsulates the details of the Bridge API and exposes them in a simpler way sufficient for rendering. Using the high-level API is strongly recommended unless there are specific needs which require using the low-level API. See the API component mi::bridge::IBridge_server for the Bridge API, and mi::bridge::IIray_bridge_server for the Iray Bridge API.

See Also
Iray Bridge, Bridge client

Enumeration Type Documentation

The different states a server session can be in.

See Also
mi::bridge::IServer_session::get_state()
Enumerator
SERVER_SESSION_CONNECTING 

A client has connected to the application but has not yet been approved.

SERVER_SESSION_CONNECTED 

The session has successfully established a connection to the Bridge application.

SERVER_SESSION_PENDING 

The session was disconnected unexpectedly and is waiting for the client to reconnect.

SERVER_SESSION_CLOSED 

The session has been closed.