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

#include <cel_http.h>

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

Public Member Functions

virtual unsigned int getStatusCode () const =0
 
virtual size_t getHeaderCount () const =0
 
virtual void getNthHeader (HttpHeaderEntry &outHeader, size_t inIndex) const =0
 
virtual String getHeader (const String &inHeaderName) const =0
 
virtual uint64_t getContentLength () 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

HttpResponseStream represents the HTTP response from the server. Any instances of this class is created by HttpRequestStream::post method.

See Also
HttpRequestStream, HttpConnection, HttpManager

Member Function Documentation

virtual uint64_t Celartem::HttpResponseStream::getContentLength ( ) const
pure virtual

This method returns "Content-Length" of the receiving content.

Returns
The size of the content received. If the "Content-Length" header is not available, this function returns -1.
virtual String Celartem::HttpResponseStream::getHeader ( const String inHeaderName) const
pure virtual

This method returns a header entry by name.

Parameters
inHeaderNameA header name to specify the header entry.
Returns
The Header Content.
virtual size_t Celartem::HttpResponseStream::getHeaderCount ( ) const
pure virtual

This method is to get number of header entries.

Returns
The number of headers.
virtual void Celartem::HttpResponseStream::getNthHeader ( HttpHeaderEntry outHeader,
size_t  inIndex 
) const
pure virtual

This method returns a header entry by index.

Parameters
outHeaderOn return, this instance stores the header entry.
inIndexAn index to specify the header entry.
virtual unsigned int Celartem::HttpResponseStream::getStatusCode ( ) const
pure virtual

This method is to get HTTP 1.1 status code.

Returns
HTTP 1.1 status code; 200 stands for success. For more information, see HTTP 1.1 specification.

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