neuray API Programmer's Manual

mi::rtmp::IConnect_event_handler Class Reference

[RTMP server]

Description

Superclass of all handlers of connect events. A subclass gets registered via mi::rtmp::IServer::install() and will be called in the case of a connect event. There can be several connect event handlers and on new connections each will be called until one returns true or the list of handlers is exhausted.

Public Member Functions

virtual bool  handle( bool is_create, IConnection* connection, const IData* command_arguments, const IData* user_arguments) =0
Called on a connect event. More...

Member Functions

virtual bool mi::​rtmp::​IConnect_event_handler::handle( bool is_create, IConnection* connection, const IData* command_arguments, const IData* user_arguments) [pure virtual]

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_create
Indicates whether this is a new or closed connection.
connection
The corresponding connection which can be used to register call and stream event handlers.
command_arguments
The command object from the client.
user_arguments
The 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.