RealityServer Web Services API Programmer's Manual

mi::rswservices::IRtmp_authorization_context Class Reference

[Request Authorization]

Description

Context class used by authorization modules to authorize RTMP requests. This class is passed to authorization modules to allow access to the connection information. A module uses the information provided by this context to decide whether to authorize an http request or not.

See also:

IAuthorizer

mi::base::Interface_declare\< ... \>

Public Member Functions

virtual const IMap* get_arguments() const =0
Gets the connection arguments as supplied by RTMP.
virtual const char* get_peer_address() const =0
Gets the address of the peer of the connection as a string.
virtual const char* get_url() const =0
Gets the URL the RTMP connection is being made on.
virtual const IData* get_user_arguments() const =0
Gets the user arguments provided to the RTMP connect call. More...
template< class T>const T* get_user_arguments() const
Gets the user arguments provided to the RTMP connect call. More...

Member Functions

virtual const IMap* mi::​rswservices::​IRtmp_authorization_context::get_arguments() const [pure virtual]

Gets the connection arguments as supplied by RTMP.

virtual const char* mi::​rswservices::​IRtmp_authorization_context::get_peer_address() const [pure virtual]

Gets the address of the peer of the connection as a string.

virtual const char* mi::​rswservices::​IRtmp_authorization_context::get_url() const [pure virtual]

Gets the URL the RTMP connection is being made on.

virtual const IData* mi::​rswservices::​IRtmp_authorization_context::get_user_arguments() const [pure virtual]

Gets the user arguments provided to the RTMP connect call. The type of the returned value depends on how many additional arguments are provided to the NetConnection.connect() call on the client.

  • none: NULL.

  • one additional argument: a pointer to the argument itself. The user will have to interrogate the argument to find its type.

  • more than one additional arguments: an mi::IDynamic_array containing the arguments.

template< class T>

const T* mi::​rswservices::​IRtmp_authorization_context::get_user_arguments() const [inline]

Gets the user arguments provided to the RTMP connect call. The type of the returned value depends on how many additional arguments are provided to the NetConnection.connect() call on the client.

  • none: NULL.

  • one additional argument: a pointer to the argument itself. The user will have to interrogate the argument to find its type.

  • more than one additional arguments: an mi::IDynamic_array containing the arguments.

This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to call mi::base::IInterface::get_interface(const Uuid&) on the returned pointer, since the return type already is a pointer to the type T specified as template parameter.