PcapPlusPlus  Next
pcpp::TcpWindowSizeFilter Class Reference

#include <PcapFilter.h>

Inheritance diagram for pcpp::TcpWindowSizeFilter:
pcpp::IFilterWithOperator pcpp::GeneralFilter

Public Member Functions

 TcpWindowSizeFilter (uint16_t windowSize, FilterOperator op)
 
void parseToString (std::string &result) const override
 
void setWindowSize (uint16_t windowSize)
 
- Public Member Functions inherited from pcpp::IFilterWithOperator
void setOperator (FilterOperator op)
 
- Public Member Functions inherited from pcpp::GeneralFilter
virtual ~GeneralFilter ()=default
 Virtual destructor, frees the bpf program.
 
bool matchPacketWithFilter (RawPacket *rawPacket) const
 
bool matches (RawPacket const &rawPacket) const
 Match a raw packet against the filter. More...
 

Additional Inherited Members

- Protected Member Functions inherited from pcpp::GeneralFilter
bool cacheFilter () const
 Parse the filter and cache the compiled BPF program. More...
 
void invalidateCache () const
 Invalidate the cached BPF program. This method should be called whenever the filter changes.
 

Detailed Description

A class for filtering TCP packets that matches TCP window-size criteria.

For deeper understanding of the filter concept please refer to PcapFilter.h

Constructor & Destructor Documentation

◆ TcpWindowSizeFilter()

pcpp::TcpWindowSizeFilter::TcpWindowSizeFilter ( uint16_t  windowSize,
FilterOperator  op 
)
inline

A constructor that get the window-size and operator and creates the filter. For example: "filter all TCP packets with window-size less than 1000"

Parameters
[in]windowSizeThe window-size value that will be used in the filter
[in]opThe operator to use (e.g "equal", "greater than", etc.)

Member Function Documentation

◆ parseToString()

void pcpp::TcpWindowSizeFilter::parseToString ( std::string &  result) const
overridevirtual

A method that parses the class instance into BPF string format

Parameters
[out]resultAn empty string that the parsing will be written into. If the string isn't empty, its content will be overridden

Implements pcpp::GeneralFilter.

◆ setWindowSize()

void pcpp::TcpWindowSizeFilter::setWindowSize ( uint16_t  windowSize)
inline

Set window-size value

Parameters
[in]windowSizeThe window-size value that will be used in the filter