$Web_Done
<section begin="desc" />Send Web response<section end="desc" />
$Web_Done signals completion of a request.
Syntax
<section begin="syntax" /> %RC = $Web_Done( status_code, message ) <section end="syntax" />
$Web_Done accepts two optional arguments and returns a numeric result code. It is a callable $function (see Calling Sirius Mods $functions).
| Status code | Used in many cases for automatic browser error or exception handling. |
|---|---|
| Message | Further elucidation of the error. In some cases, displayed verbatim to the browser's user. |
| Code | Meaning |
|---|---|
| 0 | Completed successfully |
| -1 | Not a web thread |
$WEB_DONE return codes
Invoking $Web_Done closes the client connection, optionally sending the status code and message text to the user. Once $Web_Done is invoked, the thread may continue processing but no more calls to $WEB_ functions are allowed and nothing further may be sent to the client.
The connection to the client is also broken by a Model 204 LOGOFF or any return to command level. These are perfectly valid ways of terminating requests. The function of $Web_Done is to send the status code and error message and terminate the connection; hence no further information will be sent to the client.
Status codes and their associated messages are standardized for most Web Servers. The standards are available for browsing in Chapter 9 of the http working draft, which can be viewed at http://www.w3.org/pub/WWW/Protocols/HTTP/1.0/spec.html.
The standard codes are:
| 200 | OK |
|---|---|
| 201 | Created |
| 202 | Accepted |
| 204 | No Content |
| 301 | Moved Permanently |
| 302 | Moved Temporarily |
| 304 | Not Modified |
| 400 | Bad Request |
| 401 | Not Authorized (logon required) |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
| 501 | Not Implemented |
| 502 | Bad Gateway |
| 503 | Service Unavailable |
Use $Web_Done in error routines and to sever client connections with custom messages:
SECURE: IN AUTHS FD UID = %USER END FIND CT_SEC: COUNT RECORDS IN SECURE IF NOT COUNT IN CT_SEC THEN %X = $Web_Done('403','Forbidden') STOP END IF
Of potential value when monitoring your application, the Sirius statistic JWEBERRS reports the number of times that Janus Web Server returned one of the 4xx status codes. Also, the JSCREENS statistic counts the number of times Janus Web Server incremented the SCREENS statistic. These statistics are available as of Sirius Mods version 7.6, and they are retrievable or viewable with $SyStat or SirMon.