Identifier Set: firerender_*

channel_function firerender_register( )
procedure firerender_destroy( )
callback firerender_request { }
channel firerender_channel
string firerender_broker
string firerender_service_name

Description

Identifiers for use when running Fire as a service registered to the FireRender Service Broker. All are global.

• firerender_register( )
  A function which should be called to register the current application with the FireRender Service Broker. This is called within a start.cmd macro. It returns a channel which can subsequently be used within the firerender_request callback to return data to a client. Failure will return a null channel value

• firerender_destroy( )
  A procedure to be called when a FireRender application is shutting down within a stop.cmd macro. It returns no value.

• firerender_request { }
  A callback invoked when a client makes a request to a FireRender service. Within this callback the client request should be processed and data returned.
  Two string arrays are passed as parameters to this callback containing sets of name/value pairs passed by the client on the URL to FireRender, i.e.

firerender_request = {
    args names=string[], values=string[]
}

When the service is hit via an HTTP GET command, the name/value pairs are those on the URL submitted by the client.

When the service is hit via an HTTP POST command, the name/value pairs are optionally augmented with name/value pairs derived from the request body. If the content-type is a form, then the form name/value pairs are passed. If the content-type is any other text content, the whole body is passed as a single string value with a name "__POST". If the content-type is not text, then the body is not passed.

• firerender_channel
  The channel through which data may be returned to the client within the firerender_request callback. Commands which use this channel include write, writefile, rasdump and export. Its value is also that returned by the firerender_register function.

• firerender_broker
  The name of the web broker (servlet) to which the FireRender service is registered. This is the name supplied on the registration url when Fire was invoked as a service. In the following example firerender_broker would have a value http://mars/xmarc/FireRender

 fire -appstart=myapp.xml \
   -url="http://mars/xmarc/FireRender/register?service=MapSvc&pwd=fred"

• firerender_service_name
  The logical name of the FireRender service. This is the name supplied on the registration url when Fire was invoked as a service. In the following example firerender_service_name would have a value MapSvc

 fire -appstart=myapp.xml \
   -url="http://mars/xmarc/FireRender/register?service=MapSvc&pwd=fred"