pcpp::TextBasedProtocolMessage Class Reference

#include <TextBasedProtocol.h>

Inheritance diagram for pcpp::TextBasedProtocolMessage:

Public Member Functions
HeaderField *	getFieldByName (std::string fieldName, int index=0) const
HeaderField *	getFirstField () const
HeaderField *	getNextField (HeaderField *prevField) const
int	getFieldCount () const
virtual HeaderField *	addField (const std::string &fieldName, const std::string &fieldValue)
virtual HeaderField *	addField (const HeaderField &newField)
HeaderField *	addEndOfHeader ()
virtual HeaderField *	insertField (HeaderField *prevField, const std::string &fieldName, const std::string &fieldValue)
virtual HeaderField *	insertField (std::string prevFieldName, const std::string &fieldName, const std::string &fieldValue)
virtual HeaderField *	insertField (HeaderField *prevField, const HeaderField &newField)
bool	removeField (HeaderField *fieldToRemove)
bool	removeField (std::string fieldName, int index=0)
bool	isHeaderComplete () const
void	parseNextLayer () override
size_t	getHeaderLen () const override
void	computeCalculateFields () override
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
virtual OsiModelLayer	getOsiModelLayer () const =0

Detailed Description

An abstract base class that wraps text-based-protocol header layers (both requests and responses). It is the base class for all those layers. This class is not meant to be instantiated, hence the protected c'tor

Member Function Documentation

addEndOfHeader()

HeaderField* pcpp::TextBasedProtocolMessage::addEndOfHeader

(

)

Add the special end-of-header field (see the explanation in HeaderField)

Returns

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

addField() [1/2]

virtual HeaderField* pcpp::TextBasedProtocolMessage::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 nullptr if the field could not be created

Reimplemented in pcpp::HttpMessage.

addField() [2/2]

virtual HeaderField* pcpp::TextBasedProtocolMessage::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 nullptr if the field could not be created

Reimplemented in pcpp::HttpMessage.

computeCalculateFields()

void pcpp::TextBasedProtocolMessage::computeCalculateFields ( )

overridevirtual

Does nothing for this class

Implements pcpp::Layer.

getFieldByName()

HeaderField* pcpp::TextBasedProtocolMessage::getFieldByName	(	std::string	fieldName,
		int	index = 0
	)		const

Get a pointer to a header field by name. The search is case insensitive, meaning if a field with name "Host" exists and the fieldName parameter is "host" (all letter are lower case), this method will return a pointer to "Host" field

Parameters

[in]	fieldName	The field name
[in]	index	Optional parameter. If the field name appears more than once, this parameter will indicate which field to get. The default value is 0 (get the first appearance of the field name as appears on the packet)

Returns

A pointer to an HeaderField instance, or nullptr if field doesn't exist

getFieldCount()

int pcpp::TextBasedProtocolMessage::getFieldCount

(

)

const

Returns

The number of header fields currently in the layer (not including CRLF at the end of the header)

getFirstField()

HeaderField* pcpp::TextBasedProtocolMessage::getFirstField ( ) const

inline

Returns

A pointer to the first header field exists in this message, or nullptr if no such field exists

getHeaderLen()

size_t pcpp::TextBasedProtocolMessage::getHeaderLen ( ) const

overridevirtual

Returns

The message length

Implements pcpp::Layer.

getNextField()

HeaderField* pcpp::TextBasedProtocolMessage::getNextField ( HeaderField *  prevField ) const

inline

Get the field which appears after a certain field

Parameters

[in]

prevField

A pointer to the field

Returns

The field after prevField or nullptr if prevField is the last field. If prevField is nullptr, this method will return nullptr

insertField() [1/3]

virtual HeaderField* pcpp::TextBasedProtocolMessage::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 nullptr if the field could not be created

Reimplemented in pcpp::HttpMessage.

insertField() [2/3]

virtual HeaderField* pcpp::TextBasedProtocolMessage::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 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 in pcpp::HttpMessage.

insertField() [3/3]

virtual HeaderField* pcpp::TextBasedProtocolMessage::insertField ( std::string  prevFieldName, const std::string &  fieldName, const std::string &  fieldValue  )

virtual

Insert a new field after an existing field

Parameters

[in]	prevFieldName	A name of an existing field. If the field doesn't exist nullptr will be returned. If field name is empty ('') 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

isHeaderComplete()

bool pcpp::TextBasedProtocolMessage::isHeaderComplete

(

)

const

Indicate whether the header is complete (ending with end-of-header "\r\n\r\n" or "\n\n") or spread over more packets

Returns

True if the header is complete or false if not

parseNextLayer()

void pcpp::TextBasedProtocolMessage::parseNextLayer ( )

overridevirtual

Currently set only PayloadLayer for the rest of the data

Implements pcpp::Layer.

removeField() [1/2]

bool pcpp::TextBasedProtocolMessage::removeField

(

HeaderField *

fieldToRemove

)

Remove a field from the message

Parameters

[in]

fieldToRemove

A pointer to the field that should be removed

Returns

True if the field was removed successfully, or false otherwise (for example: if fieldToRemove is nullptr, if it doesn't exist in the message, or if the removal failed)

removeField() [2/2]

bool pcpp::TextBasedProtocolMessage::removeField	(	std::string	fieldName,
		int	index = 0
	)

Remove a field from the message

Parameters

[in]	fieldName	The name of the field that should be removed
[in]	index	Optional parameter. If the field name appears more than once, this parameter will indicate which field to remove. The default value is 0 (remove the first appearance of the field name as appears on the packet)

Returns

True if the field was removed successfully, or false otherwise (for example: if fieldName doesn't exist in the message, or if the removal failed)