pcpp::IFileReaderDevice Class Reference

#include <PcapFileDevice.h>

Inheritance diagram for pcpp::IFileReaderDevice:

Public Member Functions
virtual	~IFileReaderDevice ()=default
	A destructor for this class.
uint64_t	getFileSize () const
int	getNextPackets (RawPacketVector &packetVec, int numOfPacketsToRead=-1)
Public Member Functions inherited from pcpp::IFileDevice
std::string	getFileName () const
void	close () override
	Close the file.
bool	isOpened () const override
void	getStatistics (PcapStats &stats) const override
	Get the statistics for this device. More...
Public Member Functions inherited from pcpp::IPcapDevice
bool	setFilter (std::string filterAsString) override
bool	clearFilter () override
virtual bool	setFilter (GeneralFilter &filter)
virtual bool	setFilter (std::string filterAsString)=0
Public Member Functions inherited from pcpp::IDevice
virtual bool	open ()=0
Public Member Functions inherited from pcpp::IFilterableDevice
virtual bool	setFilter (GeneralFilter &filter)
Public Member Functions inherited from pcpp::IPcapStatisticsProvider
PcapStats	getStatistics () const
	Get statistics from the device. More...

Static Public Member Functions
static IFileReaderDevice *	getReader (const std::string &fileName)
Static Public Member Functions inherited from pcpp::IPcapDevice
static std::string	getPcapLibVersionInfo ()
static bool	matchPacketWithFilter (GeneralFilter &filter, RawPacket *rawPacket)

Protected Member Functions
	IFileReaderDevice (const std::string &fileName)
Protected Member Functions inherited from pcpp::IFileDevice
void	reportPacketProcessed (uint64_t numPackets=1)
	Report that packets were processed (read or written, depending on the device type). More...
void	reportPacketDropped (uint64_t numPackets=1)
	Report that packets were dropped (not read or not written, depending on the device type). More...
void	resetStatisticCounters ()
	Reset the internal statistic counters to zero.

Detailed Description

An abstract class (cannot be instantiated, has a private c'tor) which is the parent class for file reader devices

Constructor & Destructor Documentation

IFileReaderDevice()

pcpp::IFileReaderDevice::IFileReaderDevice ( const std::string &  fileName )

protected

A constructor for this class that gets the pcap full path file name to open. Notice that after calling this constructor the file isn't opened yet, so reading packets will fail. For opening the file call open()

Parameters

[in]

fileName

The full path of the file to read

Member Function Documentation

getFileSize()

uint64_t pcpp::IFileReaderDevice::getFileSize

(

)

const

Returns

The file size in bytes

getNextPackets()

int pcpp::IFileReaderDevice::getNextPackets	(	RawPacketVector &	packetVec,
		int	numOfPacketsToRead = -1
	)

Read the next N packets into a raw packet vector

Parameters

[out]	packetVec	The raw packet vector to read packets into
[in]	numOfPacketsToRead	Number of packets to read. If value <0 all remaining packets in the file will be read into the raw packet vector (this is the default value)

Returns

The number of packets actually read

getReader()

static IFileReaderDevice* pcpp::IFileReaderDevice::getReader ( const std::string &  fileName )

static

A static method that creates an instance of the reader best fit to read the file. It decides by the file extension: for .pcapng files it returns an instance of PcapNgFileReaderDevice and for all other extensions it returns an instance of PcapFileReaderDevice

Parameters

[in]

fileName

The file name to open

Returns

An instance of the reader to read the file. Notice you should free this instance when done using it