SourcePro® API Reference Guide

 
Loading...
Searching...
No Matches
RWHttpHeaderList Class Reference

Stores and organizes a collection of RWHttpHeaderBase objects. More...

#include <rw/http/RWHttpHeaderList.h>

Public Member Functions

 RWHttpHeaderList ()
 
bool addHeader (const RWHttpHeaderBase &hdr)
 
RWCString asString () const
 
bool contains (const RWCString &label) const
 
size_t entries () const
 
RWCString getValue (const RWCString &label) const
 
size_t index (const RWCString &label) const
 
RWHttpGenericHeader operator[] (size_t i) const
 
bool removeHeader (const RWCString &label)
 

Detailed Description

RWHttpHeaderList provides a mechanism for storing and organizing a collection of RWHttpHeaderBase objects.

Constructor & Destructor Documentation

◆ RWHttpHeaderList()

RWHttpHeaderList::RWHttpHeaderList ( void )
inline

Constructs an empty RWHttpHeaderList.

Member Function Documentation

◆ addHeader()

bool RWHttpHeaderList::addHeader ( const RWHttpHeaderBase & hdr)

Attempts to add an RWHttpHeaderBase object to the internal list of headers. If successful, it returns true. If the header cannot be added for any reason (for example, the header already exists), this function returns false.

◆ asString()

RWCString RWHttpHeaderList::asString ( ) const

Returns a string representing the header list. The string is formatted for sending as part of a request to an HTTP server. The RWCString should contain 7-bit US-ASCII data.

◆ contains()

bool RWHttpHeaderList::contains ( const RWCString & label) const
inline

Searches the header list for any header with a label of label. Returns true if the header is found. Otherwise returns false. The RWCString should contain 7-bit US-ASCII data.

◆ entries()

size_t RWHttpHeaderList::entries ( ) const
inline

Returns the number of headers currently stored in the RWHttpHeaderList.

◆ getValue()

RWCString RWHttpHeaderList::getValue ( const RWCString & label) const

Returns an RWCString representing the value of the header associated with label. If no headers with that label exist in the RWHttpHeaderList, an empty string is returned. The RWCString should contain 7-bit US-ASCII data.

◆ index()

size_t RWHttpHeaderList::index ( const RWCString & label) const
inline

Returns the index where label is found. The RWCString should contain 7-bit US-ASCII data.

◆ operator[]()

RWHttpGenericHeader RWHttpHeaderList::operator[] ( size_t i) const
inline

Returns an RWHttpGenericHeader.

◆ removeHeader()

bool RWHttpHeaderList::removeHeader ( const RWCString & label)
inline

Removes any header with a label of label from the RWHttpHeaderList. Returns true if the header is found and removed. Otherwise returns false. The RWCString should contain 7-bit US-ASCII data.

Copyright © 2024 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.