SourcePro® API Reference Guide

 
List of all members | Public Member Functions
RWHttpUserAgentHeader Class Reference

Defines an HTTP User-Agent request header. More...

#include <rw/http/RWHttpUserAgentHeader.h>

Inheritance diagram for RWHttpUserAgentHeader:
RWHttpGenericHeader RWHttpHeaderBase

Public Member Functions

 RWHttpUserAgentHeader (void)
 
 RWHttpUserAgentHeader (const RWCString &value)
 
 RWHttpUserAgentHeader (const RWHttpGenericHeader &hdr)
 
- Public Member Functions inherited from RWHttpGenericHeader
 RWHttpGenericHeader (void)
 
 RWHttpGenericHeader (const RWCString &label, RWHttpHeaderType type=RW_HTTP_ENTITY_HEADER)
 
 RWHttpGenericHeader (const RWCString &label, const RWCString &value, RWHttpHeaderType type=RW_HTTP_ENTITY_HEADER)
 
 RWHttpGenericHeader (const RWHttpHeaderBase &hdr)
 
virtual RWCString getValue (void) const
 
void setValue (const RWCString &value)
 
- Public Member Functions inherited from RWHttpHeaderBase
virtual bool append (const RWCString &str)
 
virtual RWCString asString (void) const
 
RWCString getLabel (void) const
 
RWHttpHeaderType getType () const
 
bool operator!= (const RWHttpHeaderBase &) const
 
bool operator< (const RWHttpHeaderBase &hdr) const
 
bool operator== (const RWHttpHeaderBase &h) const
 

Additional Inherited Members

- Static Public Member Functions inherited from RWHttpHeaderBase
static unsigned hash (const RWHttpHeaderBase &)
 
- Protected Member Functions inherited from RWHttpHeaderBase
 RWHttpHeaderBase (void)
 
 RWHttpHeaderBase (const RWCString &label, RWHttpHeaderType type=RW_HTTP_ENTITY_HEADER)
 

Detailed Description

RWHttpUserAgentHeader is a specialization class of RWHttpGenericHeader. It defines the HTTP User-Agent request header. It is a helper class that formats its contents as User-Agent: header_value, where header_value is text that describes the client application.

Constructor & Destructor Documentation

RWHttpUserAgentHeader::RWHttpUserAgentHeader ( void  )
inline

Constructs a default RWHttpUserAgentHeader object with the associated value of the User-Agent label set to empty.

RWHttpUserAgentHeader::RWHttpUserAgentHeader ( const RWCString value)
inline

Constructs an RWHttpUserAgentHeader object with the associated value of the User-Agent label set to value. The RWCString should contain 7-bit US-ASCII data.

RWHttpUserAgentHeader::RWHttpUserAgentHeader ( const RWHttpGenericHeader hdr)

Constructs an RWHttpUserAgentHeader object from an RWHttpGenericHeader that represents a User-Agent header. If the RWHttpGenericHeader does not represent a User-Agent header or if the value of the RWHttpGenericHeader does not conform to the formatting of a User-Agent value, an RWHttpHeaderParseError exception is thrown.

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