atscppapi::header_field_value_iterator Class Reference

A header field value iterator iterates through all header fields. More...

#include <Headers.h>

Public Member Functions
	header_field_value_iterator (void *bufp, void *hdr_loc, void *field_loc, int index)
	Constructor for header_field_value_iterator, this shouldn't need to be used directly.
	header_field_value_iterator (const header_field_value_iterator &it)
	Copy Constructor for header_field_value_iterator, this shouldn't need to be used directly.
	~header_field_value_iterator ()
std::string	operator* ()
	Dereference this iterator into a string (get the value pointed to by this iterator).
header_field_value_iterator &	operator++ ()
	Advance the iterator to the next header field value.
header_field_value_iterator	operator++ (int)
	Advance the current iterator to the next header field.
bool	operator== (const header_field_value_iterator &rhs) const
	Compare two iterators returning true if they are equal.
bool	operator!= (const header_field_value_iterator &rhs) const
	Compare two iterators returning true if they are NOT equal.
Friends
class	HeaderField

---

Detailed Description

A header field value iterator iterates through all header fields.

Definition at line 112 of file Headers.h.

---

Constructor & Destructor Documentation

atscppapi::header_field_value_iterator::header_field_value_iterator	(	void *	bufp,
		void *	hdr_loc,
		void *	field_loc,
		int	index
	)

Constructor for header_field_value_iterator, this shouldn't need to be used directly.

Parameters:

	bufp	the TSMBuffer associated with the headers
	mloc	the TSMLoc associated with the headers.
	field_loc	the TSMLoc assocated with the field.
	index	the index of the value in the HeaderField

Warning:

This shouldn't need to be used directly!

atscppapi::header_field_value_iterator::header_field_value_iterator

(

const header_field_value_iterator &

it

)

Copy Constructor for header_field_value_iterator, this shouldn't need to be used directly.

Parameters:

header_field_value_iterator

an existing iterator to copy

Warning:

This shouldn't need to be used directly!

atscppapi::header_field_value_iterator::~header_field_value_iterator

(

)

---

Member Function Documentation

bool atscppapi::header_field_value_iterator::operator!=

(

const header_field_value_iterator &

rhs

)

const

Compare two iterators returning true if they are NOT equal.

Returns:

true if two iterators are not equal.

std::string atscppapi::header_field_value_iterator::operator*

(

)

Dereference this iterator into a string (get the value pointed to by this iterator).

Returns:

a string which is the value pointed to by this iterator

header_field_value_iterator& atscppapi::header_field_value_iterator::operator++

(

)

Advance the iterator to the next header field value.

Returns:

a reference to a the next iterator

header_field_value_iterator atscppapi::header_field_value_iterator::operator++

(

int

)

Advance the current iterator to the next header field.

Returns:

a new iterator which points to the next element

bool atscppapi::header_field_value_iterator::operator==

(

const header_field_value_iterator &

rhs

)

const

Compare two iterators returning true if they are equal.

Returns:

true if two iterators are equal

---

Friends And Related Function Documentation

friend class HeaderField [friend]

Definition at line 165 of file Headers.h.

---

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

• Headers.h