pcpp::HttpMessage Class Reference

#include <HttpLayer.h>

Inheritance diagram for pcpp::HttpMessage:

Public Member Functions
HeaderField *	addField (const std::string &fieldName, const std::string &fieldValue) override
HeaderField *	addField (const HeaderField &newField) override
HeaderField *	insertField (HeaderField *prevField, const std::string &fieldName, const std::string &fieldValue) override
HeaderField *	insertField (HeaderField *prevField, const HeaderField &newField) override
OsiModelLayer	getOsiModelLayer () const override
Public Member Functions inherited from pcpp::TextBasedProtocolMessage
HeaderField *	getFieldByName (std::string fieldName, int index=0) const
HeaderField *	getFirstField () const
HeaderField *	getNextField (HeaderField *prevField) const
int	getFieldCount () const
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 () const
void	parseNextLayer () override
	Currently set only PayloadLayer for the rest of the data.
size_t	getHeaderLen () const override
void	computeCalculateFields () override
	Does nothing for this class.
Public Member Functions inherited from pcpp::Layer
	~Layer () override
Layer *	getNextLayer () const
Layer *	getPrevLayer () const
ProtocolType	getProtocol () const
bool	isMemberOfProtocolFamily (ProtocolTypeFamily protocolTypeFamily) const
uint8_t *	getData () const
size_t	getDataLen () const
uint8_t *	getLayerPayload () const
size_t	getLayerPayloadSize () const
bool	isAllocatedToPacket () const
void	copyData (uint8_t *toArr) const
uint8_t *	getDataPtr (size_t offset=0) const override
virtual std::string	toString () const =0

Static Public Member Functions
static bool	isHttpPort (uint16_t port)

Additional Inherited Members
Protected Member Functions inherited from pcpp::Layer
template<typename T , typename... Args>
Layer *	constructNextLayer (uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
template<typename T , typename TFallback , typename... Args>
Layer *	tryConstructNextLayerWithFallback (uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
Static Protected Member Functions inherited from pcpp::Layer
template<typename T >
static bool	canReinterpretAs (const uint8_t *data, size_t dataLen)
	Check if the data is large enough to reinterpret as a type. More...

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]

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

overridevirtual

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 nullptr if the field could not be created

Reimplemented from pcpp::TextBasedProtocolMessage.

addField() [2/2]

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

overridevirtual

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 nullptr if the field could not be created

Reimplemented from pcpp::TextBasedProtocolMessage.

getOsiModelLayer()

OsiModelLayer pcpp::HttpMessage::getOsiModelLayer ( ) const

inlineoverridevirtual

Returns

The OSI Model layer this protocol belongs to

Implements pcpp::Layer.

insertField() [1/2]

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

overridevirtual

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 nullptr if the field could not be created

Reimplemented from pcpp::TextBasedProtocolMessage.

insertField() [2/2]

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

overridevirtual

Insert a new field after an existing field

Parameters

[in]	prevField	A pointer to the existing field. If it's nullptr 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 nullptr if the field could not be created

Reimplemented from pcpp::TextBasedProtocolMessage.

isHttpPort()

static bool pcpp::HttpMessage::isHttpPort ( uint16_t  port )

inlinestatic

A static method that checks whether the port is considered as HTTP

Parameters

[in]

port

The port number to be checked

Returns

True if the port matches those associated with the HTTP protocol