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

Purpose

The HttpResponse object is a keyed shelf that contains information that an HTTP server will return to a client after receiving a request.

Usage Notes

You can create as many instances of the HttpResponse component as you require by declaring global and local variables of type "httpResponse". To use httpResponse components in your program, you must also include the following include statement in your program:

     include "omhttp.xin"

The HTTP response shelf contains the information needed to construct an HTTP-formatted response message that an HTTP server will return to a client after receiving a request. The HTTP response shelf contains the following keyed items:

• "last-error" -- a string describing any errors that occurred during the last function call. If no errors were detected, it is a zero-length string.
• "http-version" -- the version of HTTP used to format the message. The default value is "HTTP/1.0".
• "status-code" -- the numeric status code indicating the success of the request. The default value is "200", indicating success.
• "reason-phrase" -- a textual explanation of the status code. The default value is "OK".
• "entity-body" -- the body of information to return to the client. The default is a zero-length string.

Related omhttp - HTTP support library functions:

• HttpObjectGetCookieAttributes
• HttpRequestGetSearchItems
• HttpObjectGetHeaders
• HttpObjectGetCookieValues
• HttpObjectSetCookieValue
• HttpObjectSetCookieAttribute
• HttpObjectIsInError
• HttpObjectGetStatusReport
• HttpObjectSetHeader

Example

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

Other Library Functions HttpConnectionSendResponse HttpLibraryVersion HttpObjectGetCookieAttributes HttpObjectGetCookieValues HttpObjectGetHeaders HttpObjectGetStatusReport HttpObjectIsInError HttpObjectSetCookieAttribute HttpObjectSetCookieValue HttpObjectSetHeader HttpRequest HttpRequestGetSearchItems HttpRequestSend HttpRequestSetFromUrl HttpRequestSetProxy HttpRequestSetSearchItem HttpResponse HttpResponseOutput HttpServiceAwaitRequest

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACY LIBRARIES ] [ ERRORS ]