SourcePro® API Reference Guide

 
Loading...
Searching...
No Matches
RWHttpFromHeader Class Reference

Helper class that defines an HTTP From header. More...

#include <rw/http/RWHttpFromHeader.h>

Inheritance diagram for RWHttpFromHeader:
RWHttpGenericHeader RWHttpHeaderBase

Public Member Functions

 RWHttpFromHeader (const RWCString &value)
 
 RWHttpFromHeader (const RWHttpGenericHeader &hdr)
 
 RWHttpFromHeader (void)
 
- Public Member Functions inherited from RWHttpGenericHeader
 RWHttpGenericHeader (const RWCString &label, const RWCString &value, RWHttpHeaderType type=RW_HTTP_ENTITY_HEADER)
 
 RWHttpGenericHeader (const RWCString &label, RWHttpHeaderType type=RW_HTTP_ENTITY_HEADER)
 
 RWHttpGenericHeader (const RWHttpHeaderBase &hdr)
 
 RWHttpGenericHeader (void)
 
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 (void) 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 (const RWCString &label, RWHttpHeaderType type=RW_HTTP_ENTITY_HEADER)
 
 RWHttpHeaderBase (void)
 

Detailed Description

RWHttpFromHeader is a specialization class of RWHttpGenericHeader that defines the HTTP From header. It is a helper class that formats its contents as From: header_value, where header_value is a valid e-mail address. The validity of header_value is not checked.

Constructor & Destructor Documentation

◆ RWHttpFromHeader() [1/3]

RWHttpFromHeader::RWHttpFromHeader ( void )
inline

Constructs a default RWHttpFromHeader object with the label equal to From and the value equal to the empty string.

◆ RWHttpFromHeader() [2/3]

RWHttpFromHeader::RWHttpFromHeader ( const RWCString & value)
inline

Constructs an RWHttpFromHeader object with the label equal to From and the value equal to value. The RWCString should contain 7-bit US-ASCII data.

◆ RWHttpFromHeader() [3/3]

RWHttpFromHeader::RWHttpFromHeader ( const RWHttpGenericHeader & hdr)

Constructs an RWHttpFromHeader object from an RWHttpGenericHeader that represents a From HTTP header. If the RWHttpGenericHeader does not represent a From HTTP header or if the value of the RWHttpGenericHeader does not conform to the formatting of a From value, an RWHttpHeaderParseError exception is thrown.

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