neuray API Programmer's Manual

Bridge server

[Bridge]

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.

See the API component mi::bridge::IBridge_server for a starting point.

See also:

Bridge, Bridge client

Classes

class 
This class represents a Bridge application. More...
class 
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 
API component that serves as entry point for the server-side Bridge API. More...
class 
Context to import or remove snapshots. More...
class 
Context for incremental snapshots. More...
class 
The Iray Bridge application. More...
class 
API component that serves as entry point for the server-side Iray Bridge API. More...
class 
Represents the server-side part of a job that can be executed by the Bridge server. More...
class 
Represents the server side of a Bridge session. More...
class 
Abstract interface for callbacks for session state changes. More...
class 
Represents the server side of a Bridge transaction. More...
class 
Abstract interface for callbacks for transaction commit or abort events. More...
class 
Server-side video context that generates and encodes video frames for the corresponding client-side video context. More...
class 
Abstract interface to generate video frames that are transmitted to the corresponding client-side video context. More...
class 
This mixin class provides a default implementation for some of the methods needed by mi::bridge::IServer_job. More...

Enumerations

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

Enums

enum mi::bridge::Server_session_state

The different states a server session can be in.

See also:

mi::bridge::IServer_session::get_state()

Enumerator:

SERVER_SESSION_CONNECTING = 0
A client has connected to the application but has not yet been approved.
SERVER_SESSION_CONNECTED = 1
The session has successfully established a connection to the Bridge application.
SERVER_SESSION_PENDING = 2
The session was disconnected unexpectedly and is waiting for the client to reconnect.
SERVER_SESSION_CLOSED = 3
The session has been closed.
SERVER_SESSION_FORCE_32_BIT = 0xffffffffU