CONTROL
- Introduction to CTRL
- CONTROL Classes
- Types of Control Functions
- Control graphics
- CONTROL Functions
  - Funtions A
  - Funtions B
  - Funtions C
  - Funtions D
  - Functions E
  - Functions F
  - Functions G
  - Functions H
    - hasEvent()
      This function checks if an object defines an event.
    - hasMethod()
      The function returns TRUE when the specified method exists.
    - HOOK_aes_acknowledgeTableFunction()
      The system executes the function when you acknowledge an alert in the alert screen. Implement the function in a CONTROL library.
    - HOOK_ep_acknowledgeTableFunction()
      The system executes the function when you acknowledge a table (when you use the simple configuration). Implement the function in a CONTROL library.
    - HOOK_isAckable()
      The system executes the function when you acknowledge alarms. Implement the function in a CONTROL library.
    - hotKeyDialog()
      The function opens a window that allows you to select a hotkey for a shape.
    - hour()
      Returns the hour portion (0 to 23) of a time t.
    - html_ref()
      This function loads a reference into an HTML reference. The parameters will be replaced.
    - httpAccessLog()
      Creates an httpAccess.log file in the log directory and writes a log line for each HTTP request into the file.
    - httpCloseWebSocket()
      The function closes web sockets.
    - httpConnect()
      Registers a CTRL function as a Web resource
    - httpDisconnect()
      Remove a registered Web-Resource
    - httpGetAllHeaders()
      The function returns a mapping of all HTTP headers.
    - httpGetContent()
      This function extracts the content of the currently processing HTTP-Request.
    - httpGetHeader()
      Returns the value of the header (== key) of the last HTTP message.
    - httpGetLanguage()
      The function checks the stated client connection and returns a matching language ID. The function httpGetLanguageId() can be used to keep the same functionality but have a OaLanguage enum value returned.
    - httpGetLanguageId()
      The function checks the stated client connection and returns a matching OaLanguage enum value. This function provides the same functionality as httpGetLanguage(), but uses the new OaLanguage enum as return value.
    - httpGetMethod()
      The function returns the HTTP method of the last HTTP message.
    - httpGetPort()
      Returns the port and connection used for the HTTP request.
    - httpGetQuery()
      Returns the HTTP query elements as key/value pairs
    - httpGetURI()
      Returns the last from the Client (index) requested URI from the HTTP server.
    - httpMakeParamString()
      Returns a string from the passed arguments that represents the query part of a URL.
    - httpOnConnectionClose()
      The function starts the specified callBack function when the HTTP connection is closed.
    - httpParseDate()
      Allows parsing an RFC-2616 conform date string, e.g. from header "If-Modified-Since".
    - httpReadWebSocket()
      The function reads web sockets.
    - httpSaveFilesFromUpload()
      The function returns the HTTP content of a Blob variable that was received from an HTTP client via an HTML form. The function copies the content of this blob variable (a file) into a directory.
    - httpServer()
      Installs and activates an HTTP server.
    - httpSetMaxAge()
      Defines the time in seconds how long files should be cached by the client.
    - httpSetMaxContentLength()
      Sets the maximum length of a POST request.
    - httpSetMethodHandler()
      The function can be used to redirect an HTTP method to a user-defined CTRL callback function.
    - httpSetPermission()
      The function httpSetPemission() allows to define more fine grained user permissions for a specific URL used with the HTTP Server.
    - httpSetSecondaryAuthSuccess()
      The function is used to check for secondary authentification and implement a login delay.
    - httpSetUlcUserName()
      Sets the userName that will be used for the ULC_UX/ulc_ux_basics.html.
    - httpWriteWebSocket()
      The function writes web sockets.
  - Functions I
  - Functions J
  - Functions K
  - Functions L
  - Functions M
  - Functions N
  - Functions O
  - Functions P
  - Functions Q
  - Functions R
  - Functions S
  - Functions T
  - Functions U
  - Functions V
  - Functions W
  - Functions X
  - Functions Y
  - Functions Z
- CTRL Debugger
  With the CTRL Debugger you can debug the programming language Control.
- CtrlExtension, basics
- CTRLPPCheck
  Save time and money with increased code quality in your projects

httpSetMethodHandler()

The function can be used to redirect an HTTP method to a user-defined CTRL callback function.

Synopsis

int httpSetMethodHandler( string method, string callback);

Parameter


Parameter	Description
method	The HTTP method that should be redirected to a callback function.
callback	The callback function that is called.

Return value

The function returns 0 when it was successfully executed and -1 in case of errors.

Error

See the return values above.

Additionally, a warning is shown if unsupported or non-existent HTTP methods are called. In this case, the HTTP server also returns a warning.

Description

The function can be used to redirect an HTTP method ( e.g.: "PATCH", "PUT", "TRACE", "OPTIONS" or "DELETE") to a user-defined CTRL callback function. In other words, when an HTTP server receives a message that contains one of these methods, the specified CTRL callback function is called. The function must contain the following arguments:

callback(string clientIP, string url, int idx);

Note: Verbs that are not already implemented for use must be added manually.

Important: The following verbs are blacklisted and can not be used: "CONNECT", "HEAD", "GET", "POST" and ""(empty).


Parameter	Description
clientIP	IP of the requesting client. See example below.
url	The requested URL. See example below.
idx	The client index, meaning an internal client number. See example below.

Example

The example redirects the HTTP method "DELETE" to the callback function "deleteCB".

#uses "CtrlHTTP"
main()
{
  dyn_string names, values;
  names = makeDynString("first", "second");
  values = makeDynString("first value", "second-value");
  DebugN(httpMakeParamString(names, values)); // => "first=first%20value&second=second-value"
  //Example for httpSetMethodHandler
  httpServer(false, 8080, 0);
  httpSetMethodHandler("DELETE", "deleteCB");
  /* For this example, the client is the local computer and the
  client sends the HTTP DELETE message */
  string result;
  /* netDelete deletes the resource */
  netDelete("http://localhost:8080/path/to/document", result);
  if ( result == "done" )
  DebugN("resource was deleted");
}
string deleteCB(string clientIP, string url, int idx)
{
  DebugN("client " + clientIP + " has requested to delete " +
  url);
  return "done";
}

Assignment

CTRL PlugIn

Availability

CTRL