Celartem::HttpRequestStream Class Reference

#include <cel_http.h>

Inheritance diagram for Celartem::HttpRequestStream:

[legend]

List of all members.

Public Member Functions
virtual void	addRequestHeader (const String &inHeader)=0
virtual AutoPtr < HttpResponseStream >	post (const void *inAdditionalData=NULL, size_t inSize=0)=0
virtual String	getHostName () const =0
virtual u16	getPort () const =0
virtual bool	isOnSSL () const =0
virtual String	getUrl () const =0

---

Detailed Description

HttpRequestStream represents a request. Without calling post method, no data sent to the peer host.
The instances of this class is created only by HttpConnection::createRequestStream method. With a HttpConnection, only one instance of the HttpRequestStream can exist at a time; if you try to create several HttpRequestStream instances, they are serialized.

See also:

HttpConnection, HttpResponseStream, HttpManager

Definition at line 352 of file cel_http.h.

---

Member Function Documentation

virtual void Celartem::HttpRequestStream::addRequestHeader

(

const String &

inHeader

)

[pure virtual]

This method is to add HTTP 1.1 request header.

Parameters:

inHeader

HTTP header in the form of "HeaderName : Value".

virtual AutoPtr<HttpResponseStream> Celartem::HttpRequestStream::post	(	const void *	inAdditionalData = NULL,
		size_t	inSize = 0
	)			[pure virtual]

This method posts the request to the server and returns HttpResponseStream instance.
Please note that the HttpResponseStream internally locks the HttpRequestStream instance and the HttpRequestStream instance lives until the corresponding HttpResponseStream is released.

Parameters:

	inAdditionalData	You can specify an additional data to send to server. The data specified by inAdditionalData is concatenated just after the data that were written by writeBytes method.
	inSize	Size of the data specified by inAdditionalData, in bytes.

Returns:

Pointer to the newly created HttpResponseStream instance.

virtual String Celartem::HttpRequestStream::getHostName

(

)

const [pure virtual]

This method returns the host name of the connected peer.

Returns:

The host name of the host connected to.

virtual u16 Celartem::HttpRequestStream::getPort

(

)

const [pure virtual]

This method returns the port of the connected peer.

Returns:

The port connected to.

virtual bool Celartem::HttpRequestStream::isOnSSL

(

)

const [pure virtual]

This method returns whether this request is on the SSL connection or not.

Returns:

true if on the SSL connection, otherwise false.

virtual String Celartem::HttpRequestStream::getUrl

(

)

const [pure virtual]

This method returns the URL of the resource which is currently requested by this instance.

Returns:

The URL of the resource.

---

The documentation for this class was generated from the following file:

• cel_http.h

---

This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:17 2008.