mi::rtmp::ICall_event_handler Class Reference

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

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...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x9751dc66, 0xb064, 0x4ae8, 0xaa, 0x32, 0x54, 0x89, 0x41, 0x86, 0xcc, 0x1d >
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< 0x9751dc66, 0xb064, 0x4ae8, 0xaa, 0x32, 0x54, 0x89, 0x41, 0x86, 0xcc, 0x1d >
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

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

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

	connection	The connection on which this call event applies to.
	procedure_name	The name of the procedure call
	command_arguments	The command object from the client.
	user_arguments	The user object from the client.
[out]	response_arguments	An 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.