PcapPlusPlus  Next
pcpp::UdpLengthFilter Class Reference

#include <PcapFilter.h>

Inheritance diagram for pcpp::UdpLengthFilter:
pcpp::IFilterWithOperator pcpp::GeneralFilter

Public Member Functions

 UdpLengthFilter (uint16_t length, FilterOperator op)
 
void parseToString (std::string &result) const override
 
void setLength (uint16_t length)
 
- 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 UDP packets that matches UDP length criteria.

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

Constructor & Destructor Documentation

◆ UdpLengthFilter()

pcpp::UdpLengthFilter::UdpLengthFilter ( uint16_t  length,
FilterOperator  op 
)
inline

A constructor that get the UDP length and operator and creates the filter. For example: "filter all UDP packets with length greater or equal to 500"

Parameters
[in]lengthThe length 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::UdpLengthFilter::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.

◆ setLength()

void pcpp::UdpLengthFilter::setLength ( uint16_t  length)
inline

Set length value

Parameters
[in]lengthThe length value that will be used in the filter