SourcePro® API Reference Guide

 
List of all members | Public Member Functions | Protected Member Functions
RWHttpEntityTagHeaderBase Class Reference

Helper class that defines the basic formatting and structure of headers that take an entity tag as an argument. More...

#include <rw/http/RWHttpEntityTagHeaderBase.h>

Inheritance diagram for RWHttpEntityTagHeaderBase:
RWHttpHeaderBase RWHttpIfEntityTagRangeHeader

Public Member Functions

RWHttpEntityTag getEntityTag () const
 
virtual RWCString getValue () const
 
void setEntityTag (const RWHttpEntityTag &etag)
 
- 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
 

Protected Member Functions

 RWHttpEntityTagHeaderBase (const RWCString &label, RWHttpHeaderType type=RW_HTTP_ENTITY_HEADER)
 
 RWHttpEntityTagHeaderBase (const RWCString &label, const RWHttpEntityTag &etag, RWHttpHeaderType type=RW_HTTP_ENTITY_HEADER)
 
- Protected Member Functions inherited from RWHttpHeaderBase
 RWHttpHeaderBase (void)
 
 RWHttpHeaderBase (const RWCString &label, RWHttpHeaderType type=RW_HTTP_ENTITY_HEADER)
 

Additional Inherited Members

- Static Public Member Functions inherited from RWHttpHeaderBase
static unsigned hash (const RWHttpHeaderBase &)
 

Detailed Description

RWHttpEntityTagHeaderBase is a specialization of RWHttpHeaderBase. It is a helper class that defines the basic formatting and structure of headers that take an entity tag as an argument.

Constructor & Destructor Documentation

RWHttpEntityTagHeaderBase::RWHttpEntityTagHeaderBase ( const RWCString label,
RWHttpHeaderType  type = RW_HTTP_ENTITY_HEADER 
)
inlineprotected

Constructs a default RWHttpEntityTagHeaderBase object with the label value set to label and the internal RWHttpHeaderType set to type. The RWCString should contain 7-bit US-ASCII data.

RWHttpEntityTagHeaderBase::RWHttpEntityTagHeaderBase ( const RWCString label,
const RWHttpEntityTag etag,
RWHttpHeaderType  type = RW_HTTP_ENTITY_HEADER 
)
inlineprotected

Constructs an RWHttpEntityTagHeaderBase object with the label set to label, the entity tag set to etag, and the type set to type. The RWCString should contain 7-bit US-ASCII data.

Member Function Documentation

RWHttpEntityTag RWHttpEntityTagHeaderBase::getEntityTag ( ) const
inline

Returns the internal entity tag value.

RWCString RWHttpEntityTagHeaderBase::getValue ( void  ) const
inlinevirtual

Returns the entity tag as a HTTP formatted string. The RWCString should contain 7-bit US-ASCII data.

Implements RWHttpHeaderBase.

void RWHttpEntityTagHeaderBase::setEntityTag ( const RWHttpEntityTag etag)
inline

Sets the internal entity tag value to etag.

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