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

Abstract interface that can be used to control which sessions to a Bridge application are established, based on credentials supplied by the client. More...

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

Public Member Functions

virtual bool  on_session_connect (IServer_session *session)=0
  This method is called when a session to a Bridge application is to be established. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x8913c078, 0xeba2, 0x4e0b, 0x83, 0x44, 0x1, 0xcb, 0x2b, 0x57, 0x67, 0x3c >
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< 0x8913c078, 0xeba2, 0x4e0b, 0x83, 0x44, 0x1, 0xcb, 0x2b, 0x57, 0x67, 0x3c >
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

Abstract interface that can be used to control which sessions to a Bridge application are established, based on credentials supplied by the client.

See Also
mi::bridge::IApplication::set_session_handler()

Member Function Documentation

virtual bool mi::bridge::IApplication_session_handler::on_session_connect ( IServer_session session)
pure virtual

This method is called when a session to a Bridge application is to be established.

Use mi::bridge::IServer_session::get_security_token() to obtain the security token string supplied by the client when connecting. This token can be used to decide whether the client is allowed to connect.

Parameters
session The session that is to be established.
Returns
true to accept the session, false to reject it.