NVIDIA Iray API — software examples nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Connect_event_handler Class Reference
Inheritance diagram for Connect_event_handler:
mi::base::Interface_implement< mi::rtmp::IConnect_event_handler > mi::rtmp::IConnect_event_handler mi::base::Interface_declare< 0x57b2f74b, 0x3964, 0x45cf, 0x85, 0xcd, 0xb3, 0xd3, 0x37, 0xbf, 0x09, 0xc2 > mi::base::IInterface

Public Member Functions

 Connect_event_handler (mi::neuraylib::INeuray *neuray, mi::neuraylib::IScope *scope)
 
bool handle (bool is_create, mi::rtmp::IConnection *connection, const mi::IData *, const mi::IData *)
 Called on a connect event. More...
 
- Public Member Functions inherited from mi::base::Interface_implement< mi::rtmp::IConnect_event_handler >
 Interface_implement (Uint32 initial=1)
 Constructor. More...
 
 Interface_implement (const Interface_implement< mi::rtmp::IConnect_event_handler > &other)
 Copy constructor. More...
 
Interface_implement
< mi::rtmp::IConnect_event_handler > & 
operator= (const Interface_implement< mi::rtmp::IConnect_event_handler > &other)
 Assignment operator. More...
 
virtual Uint32 retain () const
 Increments the reference count. More...
 
virtual Uint32 release () const
 Decrements the reference count. More...
 
virtual const IInterfaceget_interface (const Uuid &interface_id) const
 Acquires a const interface. More...
 
virtual IInterfaceget_interface (const Uuid &interface_id)
 Acquires a mutable interface. More...
 
Uuid get_iid () const
 Returns the interface ID of the most derived interface. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x57b2f74b, 0x3964, 0x45cf, 0x85, 0xcd, 0xb3, 0xd3, 0x37, 0xbf, 0x09, 0xc2 >
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< 0x57b2f74b, 0x3964, 0x45cf, 0x85, 0xcd, 0xb3, 0xd3, 0x37, 0xbf, 0x09, 0xc2 >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Protected Member Functions inherited from mi::base::Interface_implement< mi::rtmp::IConnect_event_handler >
Atom32refcount () const
 Get the current refcount. More...
 
virtual ~Interface_implement ()
 
- Static Protected Member Functions inherited from mi::base::Interface_declare< 0x57b2f74b, 0x3964, 0x45cf, 0x85, 0xcd, 0xb3, 0xd3, 0x37, 0xbf, 0x09, 0xc2 >
static const IInterfaceget_interface_static (const IInterface *iinterface, const Uuid &interface_id)
 
static IInterfaceget_interface_static (IInterface *iinterface, const Uuid &interface_id)
 

Detailed Description

Definition at line 280 of file example_rtmp_server.cpp.

Constructor & Destructor Documentation

Connect_event_handler::Connect_event_handler ( mi::neuraylib::INeuray neuray,
mi::neuraylib::IScope scope 
)
inline

Definition at line 283 of file example_rtmp_server.cpp.

Member Function Documentation

bool Connect_event_handler::handle ( bool  is_create,
mi::rtmp::IConnection connection,
const mi::IData command_arguments,
const mi::IData user_arguments 
)
inlinevirtual

Called on a connect event.

If the is_create parameter is true the supplied connection can be used to register handlers for stream and call events. If the connection should be allowed it should return true. This way several connect event handlers can be installed, each responsible for different applications. When a connection is closed, the same handler that initially allowed the connection is called again but with is_create set to false. The return value is only considered when is_create is true. Note that the arguments are no longer valid after the handler has returned so the connection pointer cannot be saved away.

Note
The connection parameter is only valid during the call of the handle() method and cannot be stored (even if proper reference counting is used).
Parameters
is_createIndicates whether this is a new or closed connection.
connectionThe corresponding connection which can be used to register call and stream event handlers.
command_argumentsThe command object from the client.
user_argumentsThe user object from the client.
Returns
If is_create is false, the return value is ignored. If is_create is true, the return value indicates whether this connect event handler declares itself responsible for the connection.

Implements mi::rtmp::IConnect_event_handler.

Definition at line 286 of file example_rtmp_server.cpp.


The documentation for this class was generated from the following file: