Documentation › Modules › HTTP.em

File: HTTP.em

Functions to send and receive data over an HTTP connection using POL's internal webserver. Scripts in /scripts/www are considered at the top level directory. I.e. http://192.168.0.5:8088/online.ecl

Last modified: 02/06/2023

QueryIP()#

Explanation

returns the IP address of the connecting browser

Return values

String IP address, i.e. "192.168.0.5"

QueryParam( param )#

Parameters

param String

Explanation

Query's the accessed URL for any embedded parameters. (see your favorite HTML docs for parameter embedding! :) )
Example: http://pol.server.com:8080/querytest.ecl?par=wibble&name=
QueryParam( "par" ) ---> "wibble"
QueryParam( "name" ) --> ""
QueryParam( "heat" ) --> 0 [integer]

Return values

String value of the embedded param, or 0 if not found.

Errors

  • "Invalid parameter type"

WriteHeader( name, value )#

Parameters

name String
value String

Explanation

Writes the header provided. This function can be used to change the response's Content-Type from the default "text/html". This can only used before WriteHtml() and WriteHtmlRaw().

Return values

1 on success

Errors

  • "Socket is disconnected"
  • "Cannot send headers after WriteHtml or WriteHtmlRaw"
  • "Invalid parameter type"

WriteHtml( html )#

Parameters

html String

Explanation

Writes a line of HTML to the "virtual webpage" that will be sent to the connecting browser and appends a new-line.

Return values

1 always

Errors

  • "Socket is disconnected"
  • "Invalid parameter type"

WriteHtmlRaw( html )#

Parameters

html String

Explanation

Writes a line of HTML to the "virtual webpage" that will be sent to the connecting browser, does NOT append a new-line.

Return values

1 always

Errors

  • "Socket is disconnected"
  • "Invalid parameter type"

WriteStatus( code, reason := "" )#

Parameters

code Integer
reason String

Explanation

Writes the status code provided. If no reason provided, one will be calculated from the code (if possible). This can only used once before WriteHeader(), WriteHtml(), and WriteHtmlRaw().

Return values

1 on success

Errors

  • "Socket is disconnected"
  • "Cannot send status after WriteStatus, WriteHeader, WriteHtml, or WriteHtmlRaw"
  • "Invalid parameter type"