RealityServer Web Services API Programmer's Manual

mi::rswservices::IState Class Reference

[State Processing]

Description

Implements a state processor. A state processor can be used to persist some aspects of the execution environment based on tokens supplied by the HTTP or RTMP request.

Public Member Functions

virtual const char* get_name() const =0
The name of the state object. More...
virtual bool  initialize( IState_context* context, http::IRequest* request) =0
Initialize the RealityServer state from an HTTP request. More...
virtual bool  initialize( IState_context* context, IString* url, const IMap* arguments) =0
Initialize the RealityServer state from an RTMP RPC request. More...

Member Functions

virtual const char* mi::​rswservices::​IState::get_name() const [pure virtual]

The name of the state object.

Returns

name

virtual bool mi::​rswservices::​IState::initialize( IState_context* context, http::IRequest* request) [pure virtual]

Initialize the RealityServer state from an HTTP request. This is directly after authorization and may manipulate the incoming HTTP request before it is processed further. It is also able to setup the initial command execution environment and provide a user state to commands.

Parameters

context
state context
request
the http request

Returns

true if the request should be allowed, false to deny.

virtual bool mi::​rswservices::​IState::initialize( IState_context* context, IString* url, const IMap* arguments) [pure virtual]

Initialize the RealityServer state from an RTMP RPC request. This is called before command execution begins and may be used to setup the initial execution environment and provide a user state to commands.

Parameters

context
state context
url
the URL this request was made under.
arguments
the state arguments supplied with the request, may be NULL

Returns

true if the command request should be allowed, false to deny.