Iray SDK API nvidia_logo_transpbg.gif Up
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...

#include <ibridge_server.h>

Inheritance diagram for mi::bridge::IApplication_session_handler:

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...
 
- Public Member Functions inherited from mi::base::IInterface
virtual Uint32 retain () const =0
 Increments the reference count. More...
 
virtual Uint32 release () const =0
 Decrements the reference count. More...
 
virtual const IInterfaceget_interface (const Uuid &interface_id) const =0
 Acquires a const interface from another. More...
 
template<class T>
const T * get_interface () const
 Acquires a const interface from another. More...
 
virtual IInterfaceget_interface (const Uuid &interface_id)=0
 Acquires a mutable interface from another. More...
 
template<class T>
T * get_interface ()
 Acquires a mutable interface from another. More...
 
virtual Uuid get_iid () const =0
 Returns the interface ID of the most derived interface. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x8913c078, ... >
typedef Interface_declare< id1, ... > Self
 Own type. More...
 
typedef Uuid_t< id1, ... > IID
 Declares the interface ID (IID) of this interface. More...
 
- Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0> IID
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x8913c078, ... >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Static Public Member Functions inherited from mi::base::IInterface
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface. 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

 on_session_connect()

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
sessionThe session that is to be established.
Returns
true to accept the session, false to reject it.