pcpp::HttpMessage Class Reference

#include <HttpLayer.h>

Inheritance diagram for pcpp::HttpMessage:

Public Member Functions
virtual HeaderField *	addField (const std::string &fieldName, const std::string &fieldValue)
virtual HeaderField *	addField (const HeaderField &newField)
virtual HeaderField *	insertField (HeaderField *prevField, const std::string &fieldName, const std::string &fieldValue)
virtual HeaderField *	insertField (HeaderField *prevField, const HeaderField &newField)
OsiModelLayer	getOsiModelLayer ()
Public Member Functions inherited from pcpp::TextBasedProtocolMessage
HeaderField *	getFieldByName (std::string fieldName, int index=0)
HeaderField *	getFirstField ()
HeaderField *	getNextField (HeaderField *prevField)
int	getFieldCount ()
HeaderField *	addEndOfHeader ()
virtual HeaderField *	insertField (std::string prevFieldName, const std::string &fieldName, const std::string &fieldValue)
bool	removeField (HeaderField *fieldToRemove)
bool	removeField (std::string fieldName, int index=0)
bool	isHeaderComplete ()
virtual void	parseNextLayer ()
size_t	getHeaderLen ()
virtual void	computeCalculateFields ()
Public Member Functions inherited from pcpp::Layer
virtual	~Layer ()
Layer *	getNextLayer ()
Layer *	getPrevLayer ()
ProtocolType	getProtocol ()
uint8_t *	getData ()
size_t	getDataLen ()
uint8_t *	getLayerPayload ()
size_t	getLayerPayloadSize ()
bool	isAllocatedToPacket ()
void	copyData (uint8_t *toArr)
uint8_t *	getDataPtr (size_t offset=0)
virtual std::string	toString ()=0

Static Public Member Functions
static const std::map< uint16_t, bool > *	getHTTPPortMap ()

Detailed Description

Represents a general HTTP message. It's an abstract class and cannot be instantiated. It's inherited by HttpRequestLayer and HttpResponseLayer

Member Function Documentation

addField() [1/2]

virtual HeaderField* pcpp::HttpMessage::addField ( const std::string &  fieldName, const std::string &  fieldValue  )

virtual

Add a new header field to this message. This field will be added last (before the end-of-header field)

Parameters

[in]	fieldName	The field name
[in]	fieldValue	The field value

Returns

A pointer to the newly created header field, or NULL if the field could not be created

Reimplemented from pcpp::TextBasedProtocolMessage.

addField() [2/2]

virtual HeaderField* pcpp::HttpMessage::addField ( const HeaderField &  newField )

virtual

Add a new header field to this message. This field will be added last (before the end-of-header field)

Parameters

[in]

newField

The header field to add

Returns

A pointer to the newly created header field, or NULL if the field could not be created

Reimplemented from pcpp::TextBasedProtocolMessage.

getHTTPPortMap()

static const std::map<uint16_t, bool>* pcpp::HttpMessage::getHTTPPortMap ( )

static

Returns

A pointer to a map containing all TCP ports recognize as HTTP

getOsiModelLayer()

OsiModelLayer pcpp::HttpMessage::getOsiModelLayer ( )

inlinevirtual

Returns

The OSI Model layer this protocol belongs to

Implements pcpp::Layer.

insertField() [1/2]

virtual HeaderField* pcpp::HttpMessage::insertField ( HeaderField *  prevField, const std::string &  fieldName, const std::string &  fieldValue  )

virtual

Insert a new field after an existing field

Parameters

[in]	prevField	A pointer to the existing field. If it's NULL the new field will be added as first field
[in]	fieldName	The field name
[in]	fieldValue	The field value

Returns

A pointer to the newly created header field, or NULL if the field could not be created

Reimplemented from pcpp::TextBasedProtocolMessage.

insertField() [2/2]

virtual HeaderField* pcpp::HttpMessage::insertField ( HeaderField *  prevField, const HeaderField &  newField  )

virtual

Insert a new field after an existing field

Parameters

[in]	prevField	A pointer to the existing field
[in]	newField	The header field to add

Returns

A pointer to the newly created header field, or NULL if the field could not be created

Reimplemented from pcpp::TextBasedProtocolMessage.