rwlogo
SourcePro C++ 12.0

SourcePro® C++ API Reference Guide



   SourcePro C++
Documentation Home

RWHttpRequestStringBody Class Reference
[HTTP]

Encapsulates reading an HTTP message body from an RWCString. More...

#include <rw/http/RWHttpRequestStringBody.h>

Inheritance diagram for RWHttpRequestStringBody:
RWHttpRequestBody

List of all members.

Public Member Functions

 RWHttpRequestStringBody ()
 RWHttpRequestStringBody (const RWHttpRequestStringBody &body)
 RWHttpRequestStringBody (const RWCString &body)
virtual ~RWHttpRequestStringBody ()
virtual RWHttpRequestBodyclone () const
virtual bool isValid () const
virtual RWCString getNextChunk (size_t size)
virtual int getContentLength () const
RWCString getString () const
void setString (const RWCString &str)

Detailed Description

RWHttpRequestStringBody defines how to read a standard message body.


Constructor & Destructor Documentation

RWHttpRequestStringBody::RWHttpRequestStringBody (  )  [inline]

Constructs a default RWHttpRequestStringBody object.

RWHttpRequestStringBody::RWHttpRequestStringBody ( const RWHttpRequestStringBody body  )  [inline]

Copy constructor.

RWHttpRequestStringBody::RWHttpRequestStringBody ( const RWCString body  )  [inline]

Constructs an RWHttpRequestStringBody from a string.

virtual RWHttpRequestStringBody::~RWHttpRequestStringBody (  )  [virtual]

Virtual destructor.


Member Function Documentation

virtual RWHttpRequestBody* RWHttpRequestStringBody::clone (  )  const [virtual]

Creates a copy of the RWHttpRequestStringBody on the heap and returns a pointer to the newly allocated memory.

Implements RWHttpRequestBody.

virtual int RWHttpRequestStringBody::getContentLength (  )  const [virtual]

Returns the total length of the body object, if known. Returns -1 if the Content-Length cannot be determined.

Note:
An RWHttpRequestError exception is thrown if data without a Content-Length is sent to a server with version less than HTTP/1.1.

Implements RWHttpRequestBody.

virtual RWCString RWHttpRequestStringBody::getNextChunk ( size_t  size  )  [virtual]

Reads and returns the next size bytes from the body as an RWCString. If size bytes are not available, the remainder of the string is returned. Returns an empty string when no more data can be read.

Implements RWHttpRequestBody.

RWCString RWHttpRequestStringBody::getString (  )  const [inline]

Returns the internal body representation as an RWCString.

virtual bool RWHttpRequestStringBody::isValid (  )  const [virtual]

Always returns true for this derived class.

Implements RWHttpRequestBody.

void RWHttpRequestStringBody::setString ( const RWCString str  )  [inline]

Stores the RWCString str as the internal body of the object.

 All Classes Functions Variables Typedefs Enumerations Enumerator Friends

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.