HTTP header. More...

#include <HttpHeader.h>

Public Member Functions
PLCORE_API	HttpHeader ()
	Constructor.
PLCORE_API	HttpHeader (const HttpHeader &cSource)
	Copy constructor.
	~HttpHeader ()
	Destructor.
PLCORE_API HttpHeader &	operator= (const HttpHeader &cSource)
	Assignment operator.
PLCORE_API void	Clear ()
	Clear header.
PLCORE_API bool	IsComplete () const
	Check if HTTP header is complete.
const Container< String > &	GetEntries () const
	Get header entries.
void	AddEntry (const String &sEntry)
	Add entry.
PLCORE_API void	Parse ()
	Parse header.
PLCORE_API void	Print (bool bRaw=false) const
	Print header entries to console.
EHttpProtocol	GetProtocol () const
	Get protocol version.
EHttpMessageType	GetMessageType () const
	Get message type.
EHttpRequest	GetRequest () const
	Get request.
PLCORE_API String	GetRequestString () const
	Get request as string.
String	GetRequestUrl () const
	Get request URL.
EHttpConnection	GetConnectionType () const
	Get connection type.
uint32	GetStatusCode () const
	Get status code.
String	GetStatusString () const
	Get status string.
String	GetLocation () const
	Get location.
String	GetDate () const
	Get date.
String	GetServer () const
	Get server signature.
String	GetUserAgent () const
	Get client signature.
EHttpAuth	GetAuthenticationType () const
	Get authentication type.
String	GetAuthenticationRealm () const
	Get authentication realm.
String	GetAuthorization () const
	Get authorization string.
String	GetTransferEncoding () const
	Get transfer encoding.
bool	IsChunked () const
	Check if data is transfered "chunked".
uint32	GetContentLength () const
	Get content length.
String	GetContentLanguage () const
	Get content language.
String	GetContentType () const
	Get content type.
String	GetETag () const
	Get ETag.
bool	IsPartial () const
	Check if partial data is returned.
uint32	GetRangeMin () const
	Get start of range.
uint32	GetRangeMax () const
	Get end of range.
uint32	GetRangeTotal () const
	Get total size.
Protected Attributes
Array< String >	m_lstEntries
EHttpProtocol	m_nProtocol
EHttpMessageType	m_nMessageType
EHttpRequest	m_nRequest
String	m_sRequestUrl
EHttpConnection	m_nConnection
EHttpStatus	m_nStatusCode
String	m_sStatusString
String	m_sLocation
String	m_sDate
String	m_sServer
String	m_sUserAgent
EHttpAuth	m_nAuthType
String	m_sAuthRealm
String	m_sAuthorization
String	m_sTransferEncoding
uint32	m_nContentLength
String	m_sContentLanguage
String	m_sContentType
String	m_sETag
bool	m_bPartial
uint32	m_nRangeMin
uint32	m_nRangeMax
uint32	m_nRangeTotal

Detailed Description

HTTP header.

Constructor & Destructor Documentation

PLCORE_API PLCore::HttpHeader::HttpHeader ( )

Constructor.

PLCORE_API PLCore::HttpHeader::HttpHeader ( const HttpHeader & cSource )

Copy constructor.

Parameters:

[in] cSource HTTP header

PLCore::HttpHeader::~HttpHeader ( ) [inline]

Destructor.

Member Function Documentation

PLCORE_API HttpHeader& PLCore::HttpHeader::operator= ( const HttpHeader & cSource )

Assignment operator.

Parameters:

[in] cSource HTTP header

Returns:: Reference to this header

PLCORE_API void PLCore::HttpHeader::Clear ( )

Clear header.

PLCORE_API bool PLCore::HttpHeader::IsComplete ( ) const

Check if HTTP header is complete.

Returns:: 'true' if header is complete, else 'false'

const Container< String > & PLCore::HttpHeader::GetEntries ( ) const [inline]

Get header entries.

Returns:: List of header entries

void PLCore::HttpHeader::AddEntry ( const String & sEntry ) [inline]

Add entry.

Add header entry.

Parameters:

[in] sEntry Header entry

PLCORE_API void PLCore::HttpHeader::Parse ( )

Parse header.

Remarks:: This function will parse and interpret all header entries. Call this function after you have received the header, then you can access the parsed information via their get-methods (GetSize(), GetContentType(), etc.)

PLCORE_API void PLCore::HttpHeader::Print ( bool bRaw = false ) const

Print header entries to console.

Parameters:

[in] bRaw If 'true', all header entries will be printed out, otherwise only those which are known by this implementation

EHttpProtocol PLCore::HttpHeader::GetProtocol ( ) const [inline]

Get protocol version.

Returns:: HTTP Protocol version

Remarks:: To access this information, Parse() has to be called first

EHttpMessageType PLCore::HttpHeader::GetMessageType ( ) const [inline]

Get message type.

Returns:: HTTP message type (request or response)

Remarks:: To access this information, Parse() has to be called first

EHttpRequest PLCore::HttpHeader::GetRequest ( ) const [inline]

Get request.

Returns:: HTTP request type

Remarks:: To access this information, Parse() has to be called first

PLCORE_API String PLCore::HttpHeader::GetRequestString ( ) const

Get request as string.

Returns:: HTTP request type

Remarks:: To access this information, Parse() has to be called first

String PLCore::HttpHeader::GetRequestUrl ( ) const [inline]

Get request URL.

Returns:: HTTP request URL

Remarks:: To access this information, Parse() has to be called first

EHttpConnection PLCore::HttpHeader::GetConnectionType ( ) const [inline]

Get connection type.

Returns:: HTTP connection type

Remarks:: To access this information, Parse() has to be called first

uint32 PLCore::HttpHeader::GetStatusCode ( ) const [inline]

Get status code.

Returns:: Status code

Remarks:: To access this information, Parse() has to be called first

String PLCore::HttpHeader::GetStatusString ( ) const [inline]

Get status string.

Returns:: Status string

Remarks:: To access this information, Parse() has to be called first

String PLCore::HttpHeader::GetLocation ( ) const [inline]

Get location.

Returns:: Location

Remarks:: To access this information, Parse() has to be called first

String PLCore::HttpHeader::GetDate ( ) const [inline]

Get date.

Returns:: Date

Remarks:: To access this information, Parse() has to be called first

String PLCore::HttpHeader::GetServer ( ) const [inline]

Get server signature.

Returns:: Server signature

Remarks:: To access this information, Parse() has to be called first

String PLCore::HttpHeader::GetUserAgent ( ) const [inline]

Get client signature.

Returns:: Client signature

Remarks:: To access this information, Parse() has to be called first

EHttpAuth PLCore::HttpHeader::GetAuthenticationType ( ) const [inline]

Get authentication type.

Returns:: Authentication type

Remarks:: To access this information, Parse() has to be called first

String PLCore::HttpHeader::GetAuthenticationRealm ( ) const [inline]

Get authentication realm.

Returns:: Authentication realm

Remarks:: To access this information, Parse() has to be called first

String PLCore::HttpHeader::GetAuthorization ( ) const [inline]

Get authorization string.

Returns:: Authorization string

Remarks:: To access this information, Parse() has to be called first

String PLCore::HttpHeader::GetTransferEncoding ( ) const [inline]

Get transfer encoding.

Returns:: Transfer encoding

Remarks:: To access this information, Parse() has to be called first

bool PLCore::HttpHeader::IsChunked ( ) const [inline]

Check if data is transfered "chunked".

Returns:: 'true' if transfer encoding is "chunked", else 'false'

Remarks:: To access this information, Parse() has to be called first

uint32 PLCore::HttpHeader::GetContentLength ( ) const [inline]

Get content length.

Returns:: Content length

Remarks:: To access this information, Parse() has to be called first

String PLCore::HttpHeader::GetContentLanguage ( ) const [inline]

Get content language.

Returns:: Content language

Remarks:: To access this information, Parse() has to be called first

String PLCore::HttpHeader::GetContentType ( ) const [inline]

Get content type.

Returns:: Content type

Remarks:: To access this information, Parse() has to be called first

String PLCore::HttpHeader::GetETag ( ) const [inline]

Get ETag.

Returns:: ETag for content

Remarks:: To access this information, Parse() has to be called first

bool PLCore::HttpHeader::IsPartial ( ) const [inline]

Check if partial data is returned.

Returns:: 'true' if partial data is returned, else 'false'

Remarks:: To access this information, Parse() has to be called first

uint32 PLCore::HttpHeader::GetRangeMin ( ) const [inline]

Get start of range.

Returns:: Byte position

Remarks:: To access this information, Parse() has to be called first

uint32 PLCore::HttpHeader::GetRangeMax ( ) const [inline]

Get end of range.

Returns:: Byte position

Remarks:: To access this information, Parse() has to be called first

uint32 PLCore::HttpHeader::GetRangeTotal ( ) const [inline]

Get total size.

Returns:: Size

Remarks:: To access this information, Parse() has to be called first

Member Data Documentation

Array<String> PLCore::HttpHeader::m_lstEntries [protected]

Header entries

EHttpProtocol PLCore::HttpHeader::m_nProtocol [protected]

HTTP protocol version

EHttpMessageType PLCore::HttpHeader::m_nMessageType [protected]

Message type (request or response)

EHttpRequest PLCore::HttpHeader::m_nRequest [protected]

Request type

String PLCore::HttpHeader::m_sRequestUrl [protected]

Request URL

EHttpConnection PLCore::HttpHeader::m_nConnection [protected]

Connection type (Close or KeepAlive)

EHttpStatus PLCore::HttpHeader::m_nStatusCode [protected]

Status code

String PLCore::HttpHeader::m_sStatusString [protected]

Status string

String PLCore::HttpHeader::m_sLocation [protected]

Location

String PLCore::HttpHeader::m_sDate [protected]

Date

String PLCore::HttpHeader::m_sServer [protected]

Server signature

String PLCore::HttpHeader::m_sUserAgent [protected]

Client signature

EHttpAuth PLCore::HttpHeader::m_nAuthType [protected]

Authentication type

String PLCore::HttpHeader::m_sAuthRealm [protected]

Authentication realm

String PLCore::HttpHeader::m_sAuthorization [protected]

Authorization string

String PLCore::HttpHeader::m_sTransferEncoding [protected]

Transfer encoding

uint32 PLCore::HttpHeader::m_nContentLength [protected]

Content size

String PLCore::HttpHeader::m_sContentLanguage [protected]

Content language

String PLCore::HttpHeader::m_sContentType [protected]

Content type (MIME type)

String PLCore::HttpHeader::m_sETag [protected]

ETag (identifier for content)

bool PLCore::HttpHeader::m_bPartial [protected]

Partial download?

uint32 PLCore::HttpHeader::m_nRangeMin [protected]

Start of range (for partial content)

uint32 PLCore::HttpHeader::m_nRangeMax [protected]

End of range (for partial content)

uint32 PLCore::HttpHeader::m_nRangeTotal [protected]

Total size (for partial content)

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation