DiCE API nvidia_logo_transpbg.gif Up
mi::rtmp::ICall_event_handler Class Referenceabstract

Superclass of all handlers of call events. More...

#include <rtmp.h>

Inheritance diagram for mi::rtmp::ICall_event_handler:

Public Member Functions

virtual bool handle (IConnection *connection, const char *procedure_name, const IData *command_arguments, const IData *user_arguments, IData **response_arguments)=0
 Called on a remote call event. 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< 0x9751dc66, ... >
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< 0x9751dc66, ... >
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

Superclass of all handlers of call events.

A subclass gets registered via mi::rtmp::IConnection::register_remote_call_handler() and will then be called in the case of a call event.

Member Function Documentation

 handle()

virtual bool mi::rtmp::ICall_event_handler::handle ( IConnection connection,
const char *  procedure_name,
const IData command_arguments,
const IData user_arguments,
IData **  response_arguments 
)
pure virtual

Called on a remote call event.

A call event is a form of remote procedure call from the client application to the RTMP server. Call handlers for remote commands are registered together with the name of the remote procedure call. The command and user objects supplied represent the command and user objects sent in the RTMP Call packet. The last argument is the outgoing response object where for example an error description or system statistics can be provided.

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
connectionThe connection on which this call event applies to.
procedure_nameThe name of the procedure call
command_argumentsThe command object from the client.
user_argumentsThe user object from the client.
[out]response_argumentsAn empty object which the handler can use to pass data back to the client in the response.
Returns
true if the call succeeded, false otherwise.