NVIDIA Iray API Home  Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::bridge::IServer_session Class Referenceabstract

Represents the server side of a Bridge session. More...

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

Public Member Functions

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

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x42574f4a, 0xfab1, 0x4fdc, 0xa0, 0xc7, 0x52, 0x48, 0xba, 0xfa, 0x8e, 0x7d >
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< 0x42574f4a, 0xfab1, 0x4fdc, 0xa0, 0xc7, 0x52, 0x48, 0xba, 0xfa, 0x8e, 0x7d >
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

Member Function Documentation

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.