pcpp::HttpResponseLayer Class Reference

#include <HttpLayer.h>

Inheritance diagram for pcpp::HttpResponseLayer:

Public Member Functions
	HttpResponseLayer (uint8_t *data, size_t dataLen, Layer *prevLayer, Packet *packet)
	HttpResponseLayer (HttpVersion version, const HttpResponseStatusCode &statusCode, const std::string &statusCodeString)
	HttpResponseLayer (HttpVersion version, const HttpResponseStatusCode &statusCode)
	HttpResponseLayer (const HttpResponseLayer &other)
HttpResponseLayer &	operator= (const HttpResponseLayer &other)
HttpResponseFirstLine *	getFirstLine () const
HeaderField *	setContentLength (int contentLength, const std::string &prevFieldName="")
int	getContentLength () const
std::string	toString () const override
Public Member Functions inherited from pcpp::HttpMessage
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

Additional Inherited Members
Static Public Member Functions inherited from pcpp::HttpMessage
static bool	isHttpPort (uint16_t port)
Protected Member Functions inherited from pcpp::Layer
Packet *	getAttachedPacket ()
	Get a pointer to the Packet this layer is attached to (if any). More...
Packet const *	getAttachedPacket () const
	Get a pointer to the Packet this layer is attached to (if any). More...
template<typename T , typename... Args>
Layer *	constructNextLayer (uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Construct the next layer in the protocol stack. No validation is performed on the data. More...
template<typename T , typename... Args>
Layer *	constructNextLayer (uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
template<typename TFactory , typename... Args>
Layer *	constructNextLayerFromFactory (TFactory factoryFn, uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Construct the next layer in the protocol stack using a factory functor. More...
template<typename TFactory , typename... Args>
Layer *	constructNextLayerFromFactory (TFactory factoryFn, uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
	Construct the next layer in the protocol stack using a factory functor. More...
template<typename T , typename... Args>
Layer *	tryConstructNextLayer (uint8_t *data, size_t dataLen, Args &&... extraArgs)
template<typename T , typename... Args>
Layer *	tryConstructNextLayer (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, Args &&... extraArgs)
	Try to construct the next layer in the protocol stack with a fallback option. More...
template<typename T , typename TFallback , typename... Args>
Layer *	tryConstructNextLayerWithFallback (uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
template<typename TFallback , typename TFactory , typename... Args>
Layer *	tryConstructNextLayerFromFactoryWithFallback (TFactory factoryFn, uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Try to construct the next layer in the protocol stack using a factory functor with a fallback option. More...
template<typename TFallback , typename TFactory , typename... Args>
Layer *	tryConstructNextLayerFromFactoryWithFallback (TFactory factoryFn, uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
	Try to construct the next layer in the protocol stack using a factory functor with a fallback option. More...
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 an HTTP response header and inherits all basic functionality of HttpMessage and TextBasedProtocolMessage. The functionality that is added for this class is the HTTP first line concept. An HTTP response has the following first line: 200 OK HTTP/1.1 Since it's not an "ordinary" HTTP field, it requires a special treatment and gets a class of it's own: HttpResponseFirstLine. Unlike most L2-4 protocols, an HTTP response header can spread over more than 1 packet. PcapPlusPlus currently doesn't support a header that is spread over more than 1 packet so in such cases: 1) only the first packet will be parsed as HttpResponseLayer (the other packets won't be recognized as HttpResponseLayer) and 2) the HTTP header for the first packet won't be complete (as it continues in the following packets), this why PcapPlusPlus can indicate that HTTP response header is complete or not (doesn't end with "\r\n\r\n" or "\n\n") using HttpMessage::isHeaderComplete()

Constructor & Destructor Documentation

HttpResponseLayer() [1/4]

pcpp::HttpResponseLayer::HttpResponseLayer	(	uint8_t *	data,
		size_t	dataLen,
		Layer *	prevLayer,
		Packet *	packet
	)

A constructor that creates the layer from an existing packet raw data

Parameters

[in]	data	A pointer to the raw data
[in]	dataLen	Size of the data in bytes
[in]	prevLayer	A pointer to the previous layer
[in]	packet	A pointer to the Packet instance where layer will be stored in

HttpResponseLayer() [2/4]

pcpp::HttpResponseLayer::HttpResponseLayer ( HttpVersion  version, const HttpResponseStatusCode &  statusCode, const std::string &  statusCodeString  )

explicit

A constructor that allocates a new HTTP response header with only the first line filled. Object will be created without further fields. The user can then add fields using addField() methods

Parameters

[in]	version	HTTP version to be used
[in]	statusCode	Status code to be used
[in]	statusCodeString	Most status codes have their default string, e.g 200 is usually "OK", 404 is usually "Not Found", etc. But the user can set a non-default status code string and it will be written in the header first line. Empty string ("") means using the default status code string

Deprecated:

Use other constructors instead.

HttpResponseLayer() [3/4]

pcpp::HttpResponseLayer::HttpResponseLayer ( HttpVersion  version, const HttpResponseStatusCode &  statusCode  )

explicit

A constructor that allocates a new HTTP response header with only the first line filled. Object will be created without further fields. The user can then add fields using addField() methods

Parameters

[in]	version	HTTP version to be used
[in]	statusCode	Status code to be used

HttpResponseLayer() [4/4]

pcpp::HttpResponseLayer::HttpResponseLayer

(

const HttpResponseLayer &

other

)

A copy constructor for this layer. This copy constructor inherits base copy constructor HttpMessage::HttpMessage() and adds the functionality of copying the first line as well

Parameters

[in]

other

The instance to copy from

Member Function Documentation

getContentLength()

int pcpp::HttpResponseLayer::getContentLength

(

)

const

The length of the body of many HTTP response messages is determined by a HTTP header field called "Content-Length". This method parses this field, extracts its value and return it. If this field doesn't exist the method will return 0

Returns

HTTP response body length determined by "Content-Length" field

getFirstLine()

HttpResponseFirstLine* pcpp::HttpResponseLayer::getFirstLine ( ) const

inline

Returns

A pointer to the first line instance for this message

operator=()

HttpResponseLayer& pcpp::HttpResponseLayer::operator=

(

const HttpResponseLayer &

other

)

An assignment operator overload for this layer. This method inherits base assignment operator HttpMessage::operator=() and adds the functionality of copying the first line as well

Parameters

[in]

other

The instance to copy from

Returns

A reference to the assignee

setContentLength()

HeaderField* pcpp::HttpResponseLayer::setContentLength	(	int	contentLength,
		const std::string &	prevFieldName = ""
	)

The length of the body of many HTTP response messages is determined by a HTTP header field called "Content-Length". This method sets The content-length field value. The method supports several cases:

• If the "Content-Length" field exists - the method will only replace the existing value with the new value
• If the "Content-Length" field doesn't exist - the method will create this field and put the value in it. Here are also 2 cases:
• If prevFieldName is specified - the new "Content-Length" field will be created after it
• If prevFieldName isn't specified or doesn't exist - the new "Content-Length" field will be created as the last field before end-of-header field

Parameters

[in]	contentLength	The content length value to set
[in]	prevFieldName	Optional field, if specified and "Content-Length" field doesn't exist, it will be created after it

Returns

A pointer to the "Content-Length" field, or nullptr if creation failed for some reason

toString()

std::string pcpp::HttpResponseLayer::toString ( ) const

overridevirtual

Returns

A string representation of the layer most important data (should look like the layer description in Wireshark)

Implements pcpp::Layer.