#include <ossimHttpResponse.h>

Inheritance diagram for ossimHttpResponse:

Public Member Functions
	ossimHttpResponse ()

ossimByteStreamBuffer &	headerBuffer ()

const ossimByteStreamBuffer &	headerBuffer () const

ossimByteStreamBuffer &	bodyBuffer ()

const ossimByteStreamBuffer &	bodyBuffer () const

std::iostream &	headerStream ()

std::iostream &	bodyStream ()

virtual std::istream *	getInputStream ()
	This might have to change in the future if we start doing other protocols such as ftp scp, ... More...

virtual void	clear ()
	Clears out the Response and prepares for a new response. More...

void	convertHeaderStreamToKeywordlist ()
	This will parse out the response code from the status line and initialize the header variables into a keywordlist. More...

virtual void	clearLastError ()

virtual ossimString	getLastError () const

ossimKeywordlist &	headerKwl ()

const ossimKeywordlist &	headerKwl () const

ossim_int64	getContentLength () const

ossimString	getHeaderValue (const ossimString &headerName) const

const ossimString &	statusLine () const

ossim_uint32	getStatusCode () const

Public Member Functions inherited from ossimWebResponse
	ossimWebResponse ()

void	copyAllDataFromInputStream (ByteBuffer &buffer)

Public Member Functions inherited from ossimObject
	ossimObject ()

virtual	~ossimObject ()

virtual ossimObject *	dup () const

virtual ossimString	getShortName () const

virtual ossimString	getLongName () const

virtual ossimString	getDescription () const

virtual ossimString	getClassName () const

virtual RTTItypeid	getType () const

virtual bool	canCastTo (ossimObject *obj) const

virtual bool	canCastTo (const RTTItypeid &id) const

virtual bool	canCastTo (const ossimString &parentClassName) const

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)

virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...

virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const

virtual void	accept (ossimVisitor &visitor)

Public Member Functions inherited from ossimReferenced
	ossimReferenced ()

	ossimReferenced (const ossimReferenced &)

ossimReferenced &	operator= (const ossimReferenced &)

void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

int	referenceCount () const

Protected Attributes
ossimKeywordlist	m_headerKwl

ossimByteStreamBuffer	m_headerBuffer

ossimByteStreamBuffer	m_bodyBuffer

std::iostream	m_headerStream

std::iostream	m_bodyStream

ossimString	m_statusLine

ossim_uint32	m_statusCode

	TYPE_DATA

Additional Inherited Members
Public Types inherited from ossimWebResponse
typedef std::vector< char >	ByteBuffer

Public Attributes inherited from ossimWebResponse
	TYPE_DATA

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Detailed Description

Definition at line 21 of file ossimHttpResponse.h.

Constructor & Destructor Documentation

◆ ossimHttpResponse()

ossimHttpResponse::ossimHttpResponse ( )

inline

Definition at line 24 of file ossimHttpResponse.h.

    :m_headerStream(&m_headerBuffer),
    m_bodyStream(&m_bodyBuffer)
    {
       clear();
    }

Member Function Documentation

◆ bodyBuffer() [1/2]

ossimByteStreamBuffer& ossimHttpResponse::bodyBuffer ( )

inline

Definition at line 33 of file ossimHttpResponse.h.

33 {return m_bodyBuffer;}

ossimHttpResponse::m_bodyBuffer

ossimByteStreamBuffer m_bodyBuffer

Definition: ossimHttpResponse.h:73

◆ bodyBuffer() [2/2]

const ossimByteStreamBuffer& ossimHttpResponse::bodyBuffer ( ) const

inline

Definition at line 34 of file ossimHttpResponse.h.

34 {return m_bodyBuffer;}

ossimHttpResponse::m_bodyBuffer

ossimByteStreamBuffer m_bodyBuffer

Definition: ossimHttpResponse.h:73

◆ bodyStream()

std::iostream& ossimHttpResponse::bodyStream ( )

inline

Definition at line 37 of file ossimHttpResponse.h.

Referenced by ossimCurlHttpRequest::curlWriteResponseBody().

37 {return m_bodyStream;}

ossimHttpResponse::m_bodyStream

std::iostream m_bodyStream

Definition: ossimHttpResponse.h:75

◆ clear()

virtual void ossimHttpResponse::clear ( )

inlinevirtual

Clears out the Response and prepares for a new response.

Definition at line 45 of file ossimHttpResponse.h.

    {
       m_headerBuffer.clear();
       m_bodyBuffer.clear();
       m_headerKwl.clear();
       m_statusLine = "";
       m_statusCode = 200;
    }

◆ clearLastError()

virtual void ossimHttpResponse::clearLastError ( )

inlinevirtual

Definition at line 59 of file ossimHttpResponse.h.

59 {m_statusCode = 200;m_statusLine="";}

ossimHttpResponse::m_statusCode

ossim_uint32 m_statusCode

Definition: ossimHttpResponse.h:77

ossimHttpResponse::m_statusLine

ossimString m_statusLine

Definition: ossimHttpResponse.h:76

◆ convertHeaderStreamToKeywordlist()

void ossimHttpResponse::convertHeaderStreamToKeywordlist ( )

This will parse out the response code from the status line and initialize the header variables into a keywordlist.

Definition at line 5 of file ossimHttpResponse.cpp.

References ossimKeywordlist::clear(), getline(), m_headerBuffer, m_headerKwl, m_statusCode, m_statusLine, ossimKeywordlist::parseStream(), ossimString::split(), and statusLine().

Referenced by ossimCurlHttpRequest::getContentLength(), ossimCurlHttpRequest::getResponse(), and ossim::CurlStreamBuffer::loadBlock().

 {
    m_headerKwl.clear();
    ossimByteStreamBuffer buf(m_headerBuffer);
    
    std::istream in(&buf);
    in.seekg(0); // make sure we are at the begining
    // skip method type
    //
    std::string statusLine;
    std::getline(in, statusLine);
    m_statusLine = statusLine;
    
    m_headerKwl.parseStream(in);
    std::vector<ossimString> statusLineArray;
    m_statusLine.split(statusLineArray, " ");
    if(statusLineArray.size() > 1)
    {
       m_statusCode = statusLineArray[1].toUInt32();
    }
    else
    {
       m_statusCode = 0;
    }
 }

◆ getContentLength()

ossim_int64 ossimHttpResponse::getContentLength ( ) const

Definition at line 38 of file ossimHttpResponse.cpp.

References ossimString::empty(), ossimKeywordlist::find(), m_headerKwl, and ossimString::toInt64().

Referenced by ossim::CurlStreamBuffer::loadBlock().

 {
    ossim_float64 result = -1;
    ossimString contentLength = m_headerKwl.find("Content-Length");
    
    if(!contentLength.empty())
    {
       result = contentLength.toInt64();
    }
 
    return result;
 }

◆ getHeaderValue()

ossimString ossimHttpResponse::getHeaderValue ( const ossimString & headerName ) const

Definition at line 31 of file ossimHttpResponse.cpp.

References ossimKeywordlist::find(), and m_headerKwl.

 {
    ossimString result = m_headerKwl.find(headerName);
 
    return result;
 }

◆ getInputStream()

virtual std::istream* ossimHttpResponse::getInputStream ( )

inlinevirtual

This might have to change in the future if we start doing other protocols such as ftp scp, ...

etc.

We currently will return the main input stream that can be used to read the bytes returned from the request. If you need access to say a header stream from an http protocol then you can dynamic_cast to an ossimHttpResponse.

Implements ossimWebResponse.

Definition at line 39 of file ossimHttpResponse.h.

40 {return static_cast<std::istream*>(&m_bodyStream);}

ossimHttpResponse::m_bodyStream

std::iostream m_bodyStream

Definition: ossimHttpResponse.h:75

ossim::istream

std::basic_istream< char > istream

Base class for char input streams.

Definition: ossimIosFwd.h:20