Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

HttpClient Class Reference

List of all members.

Public Member Functions

 this (RequestMethod method, char[] url)
 this (RequestMethod method, MutableUri uri)
 ~this ()
HttpHeaders getResponseHeaders ()
HttpMutableHeaders getRequestHeaders ()
HttpMutableParams getRequestParams ()
Uri getUri ()
ResponseLine getResponse ()
int getStatus ()
bool isResponseOK ()
void addCookie (Cookie cookie)
void close ()
void reset ()
IBuffer open (IWritable pump)
IBuffer open (uint timeout=DefaultReadTimeout)
IBuffer open (uint timeout, IWritable pump)
void read (void(*sink)(char[]), long length=long.max)

Static Public Attributes

static const RequestMethod Get = {"GET"}

Protected Member Functions

SocketConduit createSocket ()

Private Attributes

MutableUri uri
IBuffer input
IBuffer output
SocketConduit socket
RequestMethod method
InternetAddress address
HttpMutableParams paramsOut
HttpHeaders headersIn
HttpMutableHeaders headersOut
HttpMutableCookies cookiesOut
ResponseLine responseLine

Static Private Attributes

static uint DefaultReadTimeout = System.Interval.Second * 3
static const char[] DefaultHttpVersion = "HTTP/1.1"

Classes

struct  RequestMethod

Detailed Description

Supports the basic needs of a client making requests of an HTTP server. The following is an example of how this might be used:

        // callback for client reader
        void sink (char[] content)
        {
                Stdout.put (content);
        }

        // create client for a GET request
        auto HttpClient client = new HttpClient (HttpClient.Get, "http://www.digitalmars.com/d/intro.html");

        // setup a Host header
        client.getRequestHeaders.add (HttpHeader.Host, client.getUri.getHost());

        // make request
        client.open ();

        // check return status for validity
        if (client.isResponseOK)
           {
           // extract content length (be aware of -1 return, for no header)
           int length = client.getResponseHeaders.getInt (HttpHeader.ContentLength);
           if (length < 0)
               length = int.max;
        
           // display all returned headers
           Stdout.put (client.getResponseHeaders);
        
           // display remaining content
           client.read (&sink, length);
           }
        else
           Stderr.put (client.getResponse);

Definition at line 101 of file HttpClient.d.


Constructor & Destructor Documentation

~this  )  [inline]
 

Attempt to clean up when garbage collected

Definition at line 181 of file HttpClient.d.

References close().


Member Function Documentation

this RequestMethod  method,
char[]  url
[inline]
 

Create a client for the given URL. The argument should be fully qualified with an "http:" or "https:" scheme, or an explicit port should be provided.

Definition at line 146 of file HttpClient.d.

References method.

this RequestMethod  method,
MutableUri  uri
[inline]
 

Create a client with the provided Uri instance. The Uri should be fully qualified with an "http:" or "https:" scheme, or an explicit port should be provided.

Definition at line 159 of file HttpClient.d.

References address, cookiesOut, Uri::getHost(), Uri::getValidPort(), headersIn, headersOut, HttpHeaders, method, paramsOut, responseLine, and uri.

HttpHeaders getResponseHeaders  )  [inline]
 

Get the current input headers, as returned by the host request.

Definition at line 192 of file HttpClient.d.

References headersIn.

Referenced by testHttpClient3().

HttpMutableHeaders getRequestHeaders  )  [inline]
 

Gain access to the request headers. Use this to add whatever headers are required for a request.

Definition at line 204 of file HttpClient.d.

References headersOut.

Referenced by testHttpClient3().

HttpMutableParams getRequestParams  )  [inline]
 

Gain access to the request parameters. Use this to add x=y style parameters to the request. These will be appended to the request assuming the original Uri does not contain any of its own.

Definition at line 218 of file HttpClient.d.

References paramsOut.

Uri getUri  )  [inline]
 

Return the Uri associated with this client

Definition at line 229 of file HttpClient.d.

References uri.

Referenced by testHttpClient3().

ResponseLine getResponse  )  [inline]
 

Return the response-line for the latest request. This takes the form of "version status reason" as defined in the HTTP RFC.

Definition at line 242 of file HttpClient.d.

References responseLine.

int getStatus  )  [inline]
 

Return the HTTP status code set by the remote server

Definition at line 253 of file HttpClient.d.

References ResponseLine::getStatus(), and responseLine.

Referenced by isResponseOK().

bool isResponseOK  )  [inline]
 

Return whether the response was OK or not

Definition at line 264 of file HttpClient.d.

References getStatus().

Referenced by testHttpClient3().

void addCookie Cookie  cookie  )  [inline]
 

Add a cookie to the outgoing headers

Definition at line 275 of file HttpClient.d.

References HttpMutableCookies::add(), and cookiesOut.

void close  )  [inline]
 

Close all resources used by a request. You must invoke this between successive open() calls.

Definition at line 287 of file HttpClient.d.

References IResource::close(), Socket::shutdown(), and socket.

Referenced by ~this().

void reset  )  [inline]
 

Reset the client such that it is ready for a new request.

Definition at line 303 of file HttpClient.d.

References headersIn, headersOut, paramsOut, and HttpTokens::reset().

SocketConduit createSocket  )  [inline, protected]
 

Overridable method to create a Socket. You may find a need to override this for some purpose; perhaps to add input or output filters.

Definition at line 318 of file HttpClient.d.

Referenced by open().

IBuffer open IWritable  pump  )  [inline]
 

Make a request for the resource specified via the constructor, using a callback for pumping additional data to the host. This defaults to a three-second timeout period. The return value represents the input buffer, from which all returned headers and content may be accessed.

Definition at line 333 of file HttpClient.d.

References DefaultReadTimeout.

Referenced by open(), and testHttpClient3().

IBuffer open uint  timeout = DefaultReadTimeout  )  [inline]
 

Make a request for the resource specified via the constructor, using the specified timeout period (in milli-seconds).The return value represents the input buffer, from which all returned headers and content may be accessed.

Definition at line 347 of file HttpClient.d.

References open().

IBuffer open uint  timeout,
IWritable  pump
[inline]
 

Make a request for the resource specified via the constructor using the specified timeout period (in micro-seconds), and a user-defined callback for pumping additional data to the host. The callback would be used when uploading data during a 'put' operation (or equivalent). The return value represents the input buffer, from which all returned headers and content may be accessed.

Definition at line 364 of file HttpClient.d.

References address, Socket::connect(), SocketConduit::createBuffer(), createSocket(), DefaultHttpVersion, DisplayWriter, MutableUri::extendQuery(), IWriter::flush(), Uri::getPath(), headersIn, headersOut, input, method, HttpClient::RequestMethod::name, CompositeToken::next(), output, paramsOut, ResponseLine::parse(), IBuffer::readable(), responseLine, SocketConduit::setTimeout(), socket, uri, and IWritable::write().

void read void(*)(char[])  sink,
long  length = long.max
[inline]
 

Definition at line 427 of file HttpClient.d.

References IBuffer::clear(), IConduit::Eof, input, SocketConduit::read(), IBuffer::readable(), socket, and IBuffer::toString().

Referenced by testHttpClient3().


Member Data Documentation

MutableUri uri [private]
 

Definition at line 110 of file HttpClient.d.

Referenced by getUri(), open(), and this().

IBuffer input [private]
 

Definition at line 111 of file HttpClient.d.

Referenced by open(), and read().

IBuffer output [private]
 

Definition at line 111 of file HttpClient.d.

Referenced by open().

SocketConduit socket [private]
 

Definition at line 113 of file HttpClient.d.

Referenced by close(), open(), and read().

RequestMethod method [private]
 

Definition at line 114 of file HttpClient.d.

Referenced by open(), and this().

InternetAddress address [private]
 

Definition at line 115 of file HttpClient.d.

Referenced by open(), and this().

HttpMutableParams paramsOut [private]
 

Definition at line 116 of file HttpClient.d.

Referenced by getRequestParams(), open(), reset(), and this().

HttpHeaders headersIn [private]
 

Definition at line 117 of file HttpClient.d.

Referenced by getResponseHeaders(), open(), reset(), and this().

HttpMutableHeaders headersOut [private]
 

Definition at line 118 of file HttpClient.d.

Referenced by getRequestHeaders(), open(), reset(), and this().

HttpMutableCookies cookiesOut [private]
 

Definition at line 119 of file HttpClient.d.

Referenced by addCookie(), and this().

ResponseLine responseLine [private]
 

Definition at line 120 of file HttpClient.d.

Referenced by getResponse(), getStatus(), open(), and this().

uint DefaultReadTimeout = System.Interval.Second * 3 [static, private]
 

Definition at line 123 of file HttpClient.d.

Referenced by open().

const char [] DefaultHttpVersion = "HTTP/1.1" [static, private]
 

Definition at line 126 of file HttpClient.d.

Referenced by open().

const RequestMethod Get = {"GET"} [static]
 

Definition at line 129 of file HttpClient.d.

Put = {"PUT"} []
 

Definition at line 130 of file HttpClient.d.

Head = {"HEAD"} []
 

Definition at line 131 of file HttpClient.d.

Post = {"POST"} []
 

Definition at line 132 of file HttpClient.d.

Trace = {"TRACE"} []
 

Definition at line 133 of file HttpClient.d.

Delete = {"DELETE"} []
 

Definition at line 134 of file HttpClient.d.

Options = {"OPTIONS"} []
 

Definition at line 135 of file HttpClient.d.

Connect = {"CONNECT"} []
 

Definition at line 136 of file HttpClient.d.


The documentation for this class was generated from the following file:
Generated on Fri May 27 18:12:01 2005 for Mango by  doxygen 1.4.0