Member Functions

virtual const char* mi::​rswservices::​IConfiguration::get_blacklist_command( mi::Uint32 index) const [pure virtual]

Gets the name of the blacklisted command at a given index.

Parameters

index

the index of the blacklist entry to retrieve.

Returns

the blacklisted command name at index or NULL if no command exists.

virtual const char* mi::​rswservices::​IConfiguration::get_content_root() const [pure virtual]

Returns the absolute path to the content root.

Returns

the content root path

virtual const char* mi::​rswservices::​IConfiguration::get_default_video_codec() const [pure virtual]

Gets the name of the default video codec type for RTMP streaming. Note that this returns the name of the codec actually used. If the configured codec is not available then this will fallback to a different value.

Returns

the codec type or NULL if RTMP is not enabled or no supported codecs are installed.

virtual const IDirectory_configuration* mi::​rswservices::​IConfiguration::get_directory( const char* pattern) const [pure virtual]

Returns a Directory configuration by pattern. Note that pattern must match exactly what is specified as the pattern in the configuration file.

Parameters

pattern

the patter to retrieve Directory configuration for.

Returns

the Directory configuration or NULL if no configuration is specified for pattern .

virtual const IDirectory_configuration* mi::​rswservices::​IConfiguration::get_directory( mi::Uint32 index) const [pure virtual]

Returns a Directory configuration by index.

Parameters

index

the index of the configuration to retrieve.

Returns

the Directory configuration or NULL if index is greater than the number of Directory configurations.

virtual bool mi::​rswservices::​IConfiguration::get_disable_default_http_handler() [pure virtual]

Returns whether the default http handler will be installed.

Returns

true if the default http handler will not be installed or false if it will be installed.

virtual bool mi::​rswservices::​IConfiguration::get_enable_http_import_api() const [pure virtual]

Returns whether the http import api will be installed.

Returns

true if the http import api will be installed or false if it will not.

virtual const char* mi::​rswservices::​IConfiguration::get_http_address() const [pure virtual]

Returns the HTTP address that RealityServer is listening on.

Returns

the address

virtual Uint32 mi::​rswservices::​IConfiguration::get_http_concurrent_connection_limit() const [pure virtual]

Returns the maximum number of current connections the HTTP server will accept.

virtual const char* mi::​rswservices::​IConfiguration::get_http_identification() const [pure virtual]

Retrieves the HTTP identification string.

Returns

the HTTP identification string.

virtual mi::Sint32 mi::​rswservices::​IConfiguration::get_http_keep_alive_timeout() const [pure virtual]

Retrieves the idle timeout for keep-alive connections.

Returns

the idle timeout for keep-alive connections.

virtual Uint32 mi::​rswservices::​IConfiguration::get_http_post_body_limit() const [pure virtual]

Returns the size limit for the body of HTTP POST requests in bytes.

virtual mi::Uint64 mi::​rswservices::​IConfiguration::get_http_send_buffer_size() const [pure virtual]

Gets the HTTP send buffer size.

Returns

the HTTP send buffer size.

virtual const char* mi::​rswservices::​IConfiguration::get_https_address() const [pure virtual]

Returns the HTTPS address that RealityServer is listening on.

Returns

the address or NULL if the HTTP server is not enabled.

virtual const char* mi::​rswservices::​IConfiguration::get_https_certificate_file() const [pure virtual]

Returns the HTTPS certificate filename.

Returns

the filename or NULL if the filename is not configured.

virtual const char* mi::​rswservices::​IConfiguration::get_https_private_key_file() const [pure virtual]

Returns the HTTPS private key filename.

Returns

the filename or NULL if the filename is not configured.

virtual const char* mi::​rswservices::​IConfiguration::get_https_private_key_password() const [pure virtual]

Returns the HTTPS private key password.

Returns

the password or NULL if the password is not configured.

virtual const char* mi::​rswservices::​IConfiguration::get_mime_type( const char* extension) const [pure virtual]

Returns the mime type associated with the given extension.

Parameters

extension

the extension

Returns

the mime type or NULL if none configured

virtual bool mi::​rswservices::​IConfiguration::get_mime_type( mi::Uint32 index, const char** extension, const char** mime_type) const [pure virtual]

Retrieve a mime type by index.

Parameters

index

the index of the mime type to retrieve.

extension

if not NULL receives the extension for the mime type.

mime_type

if not NULL receives the mime type.

Returns

true on success, false if index is greater than the number of mime types.

virtual const INeuray_configuration* mi::​rswservices::​IConfiguration::get_neuray_configuration() const [pure virtual]

Retrieves the neuray library configuration interface.

virtual const char* mi::​rswservices::​IConfiguration::get_root() const [pure virtual]

Returns the absolute path to the RealityServer root. This is the path in which the configuration file can be found.

Returns

the root path

virtual const char* mi::​rswservices::​IConfiguration::get_rtmp_address() const [pure virtual]

Returns the RTMP address that RealityServer is listening on.

Returns

the address or NULL if the RTMP server is not enabled.

virtual bool mi::​rswservices::​IConfiguration::get_uac_auto_session() const [pure virtual]

Returns whether UAC is using auto session assignment or not.

virtual const char* mi::​rswservices::​IConfiguration::get_uac_management_base_url() const [pure virtual]

Returns the base URL used for UAC management.

virtual const char* mi::​rswservices::​IConfiguration::get_uac_same_site_attribute() const [pure virtual]

Returns the value to use for the SameSite attribute in UAC cookies. Returns NULL (the default) if no attribute is set.

virtual bool mi::​rswservices::​IConfiguration::get_uac_secure_attribute() const [pure virtual]

Returns whether the Secure attribute is used in UAC cookies. If the SameSite attribute is None this is automatically enabled.

virtual Size mi::​rswservices::​IConfiguration::get_uac_sesion_timeout() const [pure virtual]

Returns the UAC session timeout in seconds. If a session is not accessed within this many seconds it is destroyed and the user slot is made available.

virtual const char* mi::​rswservices::​IConfiguration::get_uac_session_cookie() const [pure virtual]

Returns the name of the session cookie used for UAC control.

virtual const char* mi::​rswservices::​IConfiguration::get_uac_session_cookie_domain() const [pure virtual]

Returns the name of the domain that is provided with the UAC set-cookie header. Returns NULL if no explicit domain is used.

virtual Size mi::​rswservices::​IConfiguration::get_uac_user_limit() const [pure virtual]

Returns the UAC user limit. If 0 then user limiting is disabled.

virtual const IUrl_configuration* mi::​rswservices::​IConfiguration::get_url( const char* pattern) const [pure virtual]

Returns a URL configuration by pattern. Note that pattern must match exactly what is specified as the pattern in the configuration file.

Parameters

pattern

the pattern to retrieve the URL configuration for.

Returns

the URL configuration or NULL if no configuration is specified for pattern .

virtual const IUrl_configuration* mi::​rswservices::​IConfiguration::get_url( mi::Uint32 index) const [pure virtual]

Returns a URL configuration by index.

Parameters

index

the index of the configuration to retrieve.

Returns

the URL configuration or NULL if index is greater than the number of URL configurations.

virtual const IUser_configuration* mi::​rswservices::​IConfiguration::get_user( const char* name) const [pure virtual]

Returns a user configuration set.

Parameters

name

the name of the user configuration to retrieve

Returns

the user configuration or NULL if not found

virtual const IUser_configuration* mi::​rswservices::​IConfiguration::get_user( mi::Uint32 index) const [pure virtual]

Returns a user configuration set.

Returns

the user configuration or NULL if index is greater than the number of user configurations.

virtual Size mi::​rswservices::​IConfiguration::get_websocket_max_payload() const [pure virtual]

Returns the size limit for individual web socket messages in bytes.

virtual const char* mi::​rswservices::​IConfiguration::get_whitelist_command( mi::Uint32 index) const [pure virtual]

Gets the name of the whitelisted command at a given index.

Parameters

index

the index of the whitelist entry to retrieve.

Returns

the whitelisted command name at index or NULL if no command exists.