#include <HttpLayer.h>

Inheritance diagram for pcpp::HttpRequestLayer:

Public Types
enum	HttpMethod { HttpGET , HttpHEAD , HttpPOST , HttpPUT , HttpDELETE , HttpTRACE , HttpOPTIONS , HttpCONNECT , HttpPATCH , HttpMethodUnknown }
	HTTP request methods. More...

Public Member Functions
	HttpRequestLayer (uint8_t data, size_t dataLen, Layer prevLayer, Packet *packet)

	HttpRequestLayer (HttpMethod method, const std::string &uri, HttpVersion version)

	HttpRequestLayer (const HttpRequestLayer &other)

HttpRequestLayer &	operator= (const HttpRequestLayer &other)

HttpRequestFirstLine *	getFirstLine () const

std::string	getUrl () 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 request 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 request has the following first line: GET /bla/blabla.asp HTTP/1.1 Since it's not an "ordinary" HTTP field, it requires a special treatment and gets a class of it's own: HttpRequestFirstLine. Unlike most L2-4 protocols, an HTTP request 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 HttpRequestLayer (the other packets won't be recognized as HttpRequestLayer) 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 request header is complete or not(doesn't end with "\r\n\r\n" or "\n\n") using HttpMessage::isHeaderComplete()

Member Enumeration Documentation

◆ HttpMethod

enum pcpp::HttpRequestLayer::HttpMethod

HTTP request methods.

Enumerator
HttpGET	GET.
HttpHEAD	HEAD.
HttpPOST	POST.
HttpPUT	PUT.
HttpDELETE	DELETE.
HttpTRACE	TRACE.
HttpOPTIONS	OPTIONS.
HttpCONNECT	CONNECT.
HttpPATCH	PATCH.
HttpMethodUnknown	Unknown HTTP method.

Constructor & Destructor Documentation

◆ HttpRequestLayer() [1/3]

pcpp::HttpRequestLayer::HttpRequestLayer	(	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

◆ HttpRequestLayer() [2/3]

pcpp::HttpRequestLayer::HttpRequestLayer	(	HttpMethod	method,
		const std::string &	uri,
		HttpVersion	version
	)

A constructor that allocates a new HTTP request 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]	method	The HTTP method used in this HTTP request
[in]	uri	The URI of the first line
[in]	version	HTTP version to be used in this request

◆ HttpRequestLayer() [3/3]

pcpp::HttpRequestLayer::HttpRequestLayer ( const HttpRequestLayer & other )

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

Parameters

[in] other The instance to copy from

Member Function Documentation

◆ getFirstLine()

HttpRequestFirstLine* pcpp::HttpRequestLayer::getFirstLine ( ) const

inline

Returns: A pointer to the first line instance for this message

◆ getUrl()

std::string pcpp::HttpRequestLayer::getUrl ( ) const

The URL is hostname+uri. So given the following URL, for example: "www.cnn.com/main.html", the hostname is "www.cnn.com" and the URI is "/.main.html". URI and hostname are split to 2 different places inside the HTTP request packet: URI is in the first line and hostname is in "HOST" field. This methods concatenates the hostname and URI to the full URL

Returns: The URL of the HTTP request message

◆ operator=()

HttpRequestLayer& pcpp::HttpRequestLayer::operator= ( const HttpRequestLayer & other )

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

Parameters

[in] other The instance to copy from

Returns: A reference to the assignee

◆ toString()

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

overridevirtual

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

Implements pcpp::Layer.

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ HttpMethod

Constructor & Destructor Documentation

◆ HttpRequestLayer() [1/3]

◆ HttpRequestLayer() [2/3]

◆ HttpRequestLayer() [3/3]

Member Function Documentation

◆ getFirstLine()

◆ getUrl()

◆ operator=()

◆ toString()