pcpp::PcapFileReaderDevice Class Reference

#include <PcapFileDevice.h>

Inheritance diagram for pcpp::PcapFileReaderDevice:

Public Member Functions
	PcapFileReaderDevice (const std::string &fileName)
virtual	~PcapFileReaderDevice ()=default
	A destructor for this class.
LinkLayerType	getLinkLayerType () const
FileTimestampPrecision	getTimestampPrecision () const
bool	getNextPacket (RawPacket &rawPacket)
bool	open ()
void	getStatistics (PcapStats &stats) const
Public Member Functions inherited from pcpp::IFileReaderDevice
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.
Public Member Functions inherited from pcpp::IPcapDevice
virtual bool	setFilter (std::string filterAsString)
bool	clearFilter ()
virtual bool	setFilter (GeneralFilter &filter)
virtual bool	setFilter (std::string filterAsString)=0
Public Member Functions inherited from pcpp::IDevice
bool	isOpened ()
Public Member Functions inherited from pcpp::IFilterableDevice
virtual bool	setFilter (GeneralFilter &filter)

Static Public Member Functions
static bool	isNanoSecondPrecisionSupported ()
Static Public Member Functions inherited from pcpp::IFileReaderDevice
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)

Additional Inherited Members
Protected Member Functions inherited from pcpp::IFileReaderDevice
	IFileReaderDevice (const std::string &fileName)

Detailed Description

A class for opening a pcap file in read-only mode. This class enable to open the file and read all packets, packet-by-packet

Constructor & Destructor Documentation

PcapFileReaderDevice()

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

inline

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

getLinkLayerType()

LinkLayerType pcpp::PcapFileReaderDevice::getLinkLayerType ( ) const

inline

Returns

The link layer type of this file

getNextPacket()

bool pcpp::PcapFileReaderDevice::getNextPacket ( RawPacket &  rawPacket )

virtual

Read the next packet from the file. Before using this method please verify the file is opened using open()

Parameters

[out]

rawPacket

A reference for an empty RawPacket where the packet will be written

Returns

True if a packet was read successfully. False will be returned if the file isn't opened (also, an error log will be printed) or if reached end-of-file

Implements pcpp::IFileReaderDevice.

getStatistics()

void pcpp::PcapFileReaderDevice::getStatistics ( PcapStats &  stats ) const

virtual

Get statistics of packets read so far. In the PcapStats struct, only the packetsRecv member is relevant. The rest of the members will contain 0

Parameters

[out]

stats

The stats struct where stats are returned

Implements pcpp::IPcapDevice.

getTimestampPrecision()

FileTimestampPrecision pcpp::PcapFileReaderDevice::getTimestampPrecision ( ) const

inline

Returns

The precision of the timestamps in the file. If the platform supports nanosecond precision, this method will return nanoseconds even if the file has microseconds since libpcap scales timestamps before supply. Otherwise, it will return microseconds.

isNanoSecondPrecisionSupported()

static bool pcpp::PcapFileReaderDevice::isNanoSecondPrecisionSupported ( )

static

A static method that checks if nano-second precision is supported in the current platform and environment

Returns

True if nano-second precision is supported, false otherwise

open()

bool pcpp::PcapFileReaderDevice::open ( )

virtual

Open the file name which path was specified in the constructor in a read-only mode

Returns

True if file was opened successfully or if file is already opened. False if opening the file failed for some reason (for example: file path does not exist)

Implements pcpp::IDevice.