How does TrafficScript work?

TrafficScript is the programming language used to create 'rules' in ZXTM.

Rules are run when a new request is recieved from a remote client, and when a new response is generated by a back-end server. When you configure a virtual server, you configure which rules are run on the request, and which are run on the response:

A request rule is run when a new request is recieved, and some data is read from the connection. The request rule can instruct ZXTM to read more data, it can modify the request, and then select which servers should be used to direct the request to. Once the request rule completes, the request is 'released' and further data from the client is streamed through to the server.

When ZXTM receives response data from the server, the response rules are run. They can also instruct ZXTM to read more data, modify the response, or even modify the original request and instruct ZXTM to resubmit it if necessary. Then the response rule completes, the response is released and further server data is streamed back to the client.

ZXTM's TrafficScript language contains a number of helper functions to make it easy to handle different protocols. For example, the 'request.endsWith()' function can be used to indicate the end of a request; ZXTM will not process any more request data until a response has been recieved from the server.
request.sendResponse() can be used if you want to generate a response directly, without sending the request to a back-end server.

Finally, TrafficScript contains a complete set of functions to manage and manipulate HTTP traffic, so a developer does not have to worry about the underlying protocol details. Request and response rules are run once all the HTTP headers have been received, and helper functions are available to inspect and set headers, body data and status codes.

Here are a few of the more commonly used HTTP helper functions:

• http.getPath() and http.setPath() - get and set the path part of the URL used in the request;
• http.getQueryString() and http.setQueryString() - get and set the query string used in an HTTP request;
• http.getHeader() and http.setHeader() - get and set named headers in the request;
• http.getCookie() and http.setCookie() - get and set cookies in the request;
• http.getFormParam() - look up a parameter in the query string or POST body of a request;
• http.getBody() and http.setBody() - Read and set the body of the HTTP request;
• http.getResponseHeader() and http.setResponseHeader() - get and set named headers in the HTTP response;
• http.getResponseCookie() and http.setResponseCookie() - get and set cookie values in the response;
• http.getResponseBody() and http.setResponseBody() - Read and set the response for an HTTP request;
• http.sendResponse() - generate and send an HTTP response;

Owen Garrett [Zeus Dev Team] 01 July 2005   1 comment