Public Member Functions | List of all members
Celartem::HttpRequestStream Class Referenceabstract

#include <cel_http.h>

Inheritance diagram for Celartem::HttpRequestStream:
Inheritance graph
[legend]

Public Member Functions

virtual void addRequestHeader (const String &inHeader)=0
 
virtual AutoPtr
< HttpResponseStream
post ()=0
 
virtual String getHostName () const =0
 
virtual u16 getPort () const =0
 
virtual bool isOnSSL () const =0
 
virtual String getUrl () const =0
 
- Public Member Functions inherited from Celartem::Stream
virtual size_t readBytes (void *buffer, size_t inSize, bool wouldBlock=false)=0
 
virtual void writeBytes (const void *buffer, size_t inSize)=0
 
virtual void flushBuffer ()=0
 
virtual bool isEof () const =0
 
virtual size_t duplicateStream (Stream *inStream, size_t inBufferSize=1024, DuplicateStreamCallback inCallback=NULL, void *inCallbackContext=NULL)
 
virtual size_t duplicateStreamBytes (Stream *inStream, size_t inMaximumByteSize, size_t inBufferSize=1024, DuplicateStreamCallback inCallback=NULL, void *inCallbackContext=NULL)
 
- Public Member Functions inherited from Celartem::Referable
 Referable ()
 
void addRef () const
 
void releaseRef () const
 
size_t getReferenceCount () const
 
- Public Member Functions inherited from Celartem::Lockable
virtual void lock () const =0
 
virtual void unlock () const =0
 

Additional Inherited Members

- Static Public Member Functions inherited from Celartem::Referable
static void dumpDbgAllRefCount ()
 

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

Member Function Documentation

virtual void Celartem::HttpRequestStream::addRequestHeader ( const String inHeader)
pure virtual

This method is to add HTTP 1.1 request header.

Parameters
inHeaderHTTP header in the form of "HeaderName : Value".
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 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.
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 AutoPtr<HttpResponseStream> Celartem::HttpRequestStream::post ( )
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.

Returns
Pointer to the newly created HttpResponseStream instance.

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

Cuminas DjVu SDK 3.0.33103
This document is made with doxygen 1.8.5 at Sun Dec 15 2013 19:38:06.
Cuminas Logo