mi::rtmp::ICall_event_handler Class Reference
[RTMP server]
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.
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...
Member Functions
- 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.
- 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.