HttpRequest

data type

Library: HTTP support (OMHTTP)
Include: omhttp.xin


Purpose

The HttpRequest object is a keyed shelf that contains information that can be sent to an HTTP server.

Usage Notes

You create the HttpRequest shelf by using HttpRequestSetFromUrl. A call to this function will create the necessary items for most uses. To use httpRequest components in your program, you must also include the following include statement in your program:

     include "omhttp.xin"

The HTTP request object is a keyed shelf used to create an HTTP-formatted request message, which can then be sent to an HTTP server. Most simple requests can be created using HttpRequestSetFromUrl, which will create sufficient items in the HTTP request shelf to cover most circumstances. The HTTP request shelf contains the following keyed items:

Related omhttp - HTTP support library functions:

The functions

Example

Within your program, you can create as many instances of the HttpRequest component as you require by declaring global and local variables of type "HttpRequest".

  ; HttpRequestSend
  
  local HttpRequest my-Request
  local HttpResponse get-Response
  
  HttpRequestSetFromUrl my-Request
     from "http://developers.omnimark.com/whats-new.html"
  
  HttpRequestSend my-Request into get-Response timeout 60000
  
  output get-Response{"entity-body"}