neuray API Programmer's Manual

mi::bridge::IServer_session Class Reference

[Bridge server]

Description

Represents the server side of a Bridge session.

See also:

mi::bridge::IServer_session_state_callback::session_state_callback() mi::bridge::IApplication_session_handler::on_session_connect()

mi::base::Interface_declare\< ... \>Mixin class template for deriving new interface declarations. The basic extensible interface.The basic extensible interface.

Public Member Functions

virtual void add_session_state_callback( IServer_session_state_callback* callback) =0
Adds a session state callback. More...
virtual IApplication* get_application() const =0
Returns the application this session belongs to.
virtual const char* get_security_token() const =0
Returns the security token specified by the client.
virtual const char* get_session_id() const =0
Returns the session ID.
virtual Server_session_state get_state() const =0
Returns the state of this session.
virtual IServer_video_context* get_video_context( Sint32 context_id) =0
Returns the video context for a given ID. More...
virtual void remove_session_state_callback( IServer_session_state_callback* callback) =0
Removes a previously added session state callback. More...

Member Functions

virtual void mi::​bridge::​IServer_session::add_session_state_callback( IServer_session_state_callback* callback) [pure virtual]

Adds a session state callback. When adding a callback it will be called immediately once with the current state, and then every time the session state changes.

See also:

remove_session_state_callback()

Parameters

callback
The callback to be added.
virtual IApplication* mi::​bridge::​IServer_session::get_application() const [pure virtual]

Returns the application this session belongs to.

virtual const char* mi::​bridge::​IServer_session::get_security_token() const [pure virtual]

Returns the security token specified by the client.

virtual const char* mi::​bridge::​IServer_session::get_session_id() const [pure virtual]

Returns the session ID.

virtual Server_session_state mi::​bridge::​IServer_session::get_state() const [pure virtual]

Returns the state of this session.

virtual IServer_video_context* mi::​bridge::​IServer_session::get_video_context( Sint32 context_id) [pure virtual]

Returns the video context for a given ID. Video contexts must first be created by the client and can then be retrieved on the server via this method. The video context ID is assigned when the video context is created on the client side and must be transfered to the server before calling this method. The recommended way to do this is to execute a Bridge job containing the video context ID and optionally other data that is required for the server-side application to set up the video source and to start producing frames.

Parameters

context_id
The video context ID.

Returns

The video context or NULL if no video context with the provided ID exists.

virtual void mi::​bridge::​IServer_session::remove_session_state_callback( IServer_session_state_callback* callback) [pure virtual]

Removes a previously added session state callback.

See also:

add_session_state_callback()

Parameters

callback
The callback to be removed.