RWHttpRange Class Reference
[HTTP]

Helper class that describes a Byte Range for requesting a portion of a document. More...

#include <rw/http/RWHttpRange.h>

List of all members.

Public Types
enum	rangeEnd { head, tail }
Public Member Functions
	RWHttpRange ()
	RWHttpRange (const RWCString &range)
	RWHttpRange (size_t offset, size_t length=0)
	RWHttpRange (size_t length, rangeEnd end)
void	setRange (const RWCString &range)
void	setRange (size_t offset, size_t length)
void	setRange (size_t length, rangeEnd end)
RWCString	getValue () const

---

Detailed Description

RWHttpRange represents an HTTP/1.1 format range for requesting portions of a document.

---

Member Enumeration Documentation

enum RWHttpRange::rangeEnd

Defines from which end of the document to start counting bytes.

Enumerator:

head	The range starts at the beginning of the document and extends toward the end.
tail	The range starts at the end of the document and extends toward the beginning.

---

Constructor & Destructor Documentation

RWHttpRange::RWHttpRange

(

)

[inline]

Constructs a default RWHttpRange object where the range is the complete document.

RWHttpRange::RWHttpRange

(

const RWCString &

range

)

[inline]

Constructs an RWHttpRange object from an RWCString. The RWCString must be a properly formatted range according to RFC 2616. The RWCString should contain 7-bit US-ASCII data.

RWHttpRange::RWHttpRange	(	size_t	offset,
		size_t	length = 0
	)			[inline]

Constructs an RWHttpRange object where the range starts at offset and continues for length bytes. A length of 0 means that the range continues to the end of the document.

RWHttpRange::RWHttpRange	(	size_t	length,
		rangeEnd	end
	)			[inline]

Constructs an RWHttpRange object where the range extends length bytes from end.

---

Member Function Documentation

RWCString RWHttpRange::getValue

(

void

)

const [inline]

Returns the range as an RWCString. The RWCString should contain 7-bit US-ASCII data.

void RWHttpRange::setRange	(	size_t	length,
		rangeEnd	end
	)

Sets the range to start at end and to extend for length bytes.

void RWHttpRange::setRange	(	size_t	offset,
		size_t	length
	)

Sets the range to start at offset and to continue for length bytes.

void RWHttpRange::setRange

(

const RWCString &

range

)

Sets the range to range. RWCString must be a properly formatted range according to RFC 2616. The RWCString should contain 7-bit US-ASCII data.