HTTP

Module Description

Classes for adding HTTP capabilities to a client application.

Classes
class	RWHttpAgent
	Provides a high-level interface for issuing common HTTP requests. More...
class	RWHttpAuthorizationHeaderBase
	Helper class that defines the header label and type for derived HTTP Authorization headers. More...
class	RWHttpBasicAuthorizationHeader
	Helper class that defines an Authorization header for Basic Access Authentication. More...
class	RWHttpClient
	Provides a low-level interface for communicating with an HTTP server. More...
class	RWHttpClientManager
	Provides a high-level interface for issuing HTTP requests using a cache of connected RWHttpClient instances. More...
class	RWHttpConnectionError
	Exception class thrown when the requested HTTP connection could not be established. More...
class	RWHttpContentLengthHeader
	Helper class that defines an HTTP Content-Length entity header. More...
class	RWHttpContentTypeHeader
	Helper class that defines an HTTP Content-Type header. More...
class	RWHttpDate
	Helper class to convert an RWDateTime instance to a date from a string and vice versa, conforming to the HTTP/1.1 specification. More...
class	RWHttpDateHeader
	Helper class that defines an HTTP Date header. More...
class	RWHttpEntityTag
	Describes an HTTP entity tag. More...
class	RWHttpEntityTagHeaderBase
	Helper class that defines the basic formatting and structure of headers that take an entity tag as an argument. More...
class	RWHttpFromHeader
	Helper class that defines an HTTP From header. More...
class	RWHttpGenericHeader
	Helper class that defines a generic HTTP header. More...
class	RWHttpHandlerError
	Exception class thrown when the handler function fails to process the entire body of a message passed to it. More...
class	RWHttpHeaderBase
	Abstract base class from which all HTTP header classes derive. More...
class	RWHttpHeaderList
	Stores and organizes a collection of RWHttpHeaderBase objects. More...
class	RWHttpHeaderParseError
	Exception class thrown when any portion of the HTTP header cannot be parsed due to non-conformance with the HTTP specification. More...
class	RWHttpHostHeader
	Helper class that defines an HTTP Host header. More...
class	RWHttpIfDateRangeHeader
	Helper class that defines an HTTP If-Range header with HTTP-date. More...
class	RWHttpIfEntityTagRangeHeader
	Helper class that defines the HTTP If-Range header with entity tag. More...
class	RWHttpIfModifiedSinceHeader
	Helper class that defines an HTTP If-Modified-Since header. More...
class	RWHttpInvalidBodyError
	Exception class thrown when an invalid body is associated with a handle or the information provided to the body cannot be processed. More...
class	RWHttpNoPendingRepliesError
	Exception class thrown when a reply is requested but there are no pending RWHttpRequests. More...
class	RWHttpRange
	Helper class that describes a Byte Range for requesting a portion of a document. More...
class	RWHttpRangeHeader
	Helper class that defines an HTTP Range header. More...
class	RWHttpRecursiveRedirectError
	Exception class thrown if a redirect location is already in the list of visited locations. More...
class	RWHttpReply
	Encapsulates HTTP headers and a protocol reply. More...
class	RWHttpReplyError
	Exception class thrown if unexpected data is found in the reply to and HTTP request. More...
class	RWHttpRequest
	Encapsulates an entire HTTP request including the request line, header list, and request body. More...
class	RWHttpRequestBody
	Encapsulates reading an HTTP message body. More...
class	RWHttpRequestError
	Exception class thrown if data without a Content-Length is sent to a server with version less than HTTP/1.1. More...
class	RWHttpRequestStreamBody
	Encapsulates reading an HTTP message body from an std::istream. More...
class	RWHttpRequestStringBody
	Encapsulates reading an HTTP message body from an RWCString. More...
class	RWHttpSocketClient
	Handle class for parent RWHttpClient, providing implementation-specific details for HTTP clients. More...
class	RWHttpUserAgentHeader
	Defines an HTTP User-Agent request header. More...

Enumerations
enum	RWHttpHeaderType { RW_HTTP_GENERAL_HEADER, RW_HTTP_REQUEST_HEADER, RW_HTTP_RESPONSE_HEADER, RW_HTTP_ENTITY_HEADER }
enum	RWHttpPipeline { RW_HTTP_FORBID_PIPELINING, RW_HTTP_ALLOW_PIPELINING }

Enumeration Type Documentation

enum RWHttpHeaderType

Header File

#include <rw/http/RWHttpHeaderBase.h>

Specifies the type of header. You can use this enumerator for ordering the headers when you send them.

Enumerator
RW_HTTP_GENERAL_HEADER	Header type for headers are not specific to requests or responses, and do not apply to the message body.
RW_HTTP_REQUEST_HEADER	Header type that is associated with HTTP requests. Request headers allow the client to pass additional information about the request, and about the client itself, to the server.
RW_HTTP_RESPONSE_HEADER	Header type that is associated with HTTP responses. Response headers allow the server to pass additional information about the response which cannot be placed in the reply status line.
RW_HTTP_ENTITY_HEADER	Entity headers define information about the resource identified by a request.

enum RWHttpPipeline

Header File

#include <rw/http/RWHttpClientImp.h>

Specifies that a request is pipelined or that a request waits until the server responds to a previous request. For information about pipelining, see the Internet Protocols Module User's Guide.

Enumerator
RW_HTTP_FORBID_PIPELINING	Pipelined requests are forbidden. Only one request may be outstanding at any given time.
RW_HTTP_ALLOW_PIPELINING	Pipelined requests are allowed. This allows multiple requests to be issued over a persistent connection without waiting for the replies to previous requests.