pcpp::PcapNgFileReaderDevice Class Reference

#include <PcapFileDevice.h>

Inheritance diagram for pcpp::PcapNgFileReaderDevice:

Public Member Functions
	PcapNgFileReaderDevice (const std::string &fileName)
virtual	~PcapNgFileReaderDevice ()
std::string	getOS () const
std::string	getHardware () const
std::string	getCaptureApplication () const
std::string	getCaptureFileComment () const
bool	getNextPacket (RawPacket &rawPacket, std::string &packetComment)
bool	getNextPacket (RawPacket &rawPacket)
bool	open ()
void	getStatistics (PcapStats &stats) const
bool	setFilter (std::string filterAsString)
void	close ()
Public Member Functions inherited from pcpp::IFileReaderDevice
virtual	~IFileReaderDevice ()
uint64_t	getFileSize () const
int	getNextPackets (RawPacketVector &packetVec, int numOfPacketsToRead=-1)
Public Member Functions inherited from pcpp::IFileDevice
std::string	getFileName () const
Public Member Functions inherited from pcpp::IPcapDevice
bool	clearFilter ()
Public Member Functions inherited from pcpp::IDevice
bool	isOpened ()
Public Member Functions inherited from pcpp::IFilterableDevice
virtual bool	setFilter (GeneralFilter &filter)

Additional Inherited Members
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)
Protected Member Functions inherited from pcpp::IFileReaderDevice
	IFileReaderDevice (const std::string &fileName)

Detailed Description

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

Constructor & Destructor Documentation

PcapNgFileReaderDevice()

pcpp::PcapNgFileReaderDevice::PcapNgFileReaderDevice

(

const std::string &

fileName

)

A constructor for this class that gets the pcap-ng 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

~PcapNgFileReaderDevice()

virtual pcpp::PcapNgFileReaderDevice::~PcapNgFileReaderDevice ( )

inlinevirtual

A destructor for this class

Member Function Documentation

close()

void pcpp::PcapNgFileReaderDevice::close ( )

virtual

Close the pacp-ng file

Reimplemented from pcpp::IFileDevice.

getCaptureApplication()

std::string pcpp::PcapNgFileReaderDevice::getCaptureApplication

(

)

const

The pcap-ng format allows storing metadata at the header of the file. Part of this metadata is a string specifying the capture application that was used for capturing the packets. This method reads this string from the metadata (if exists) and returns it

Returns

The capture application string if exists, or an empty string otherwise

getCaptureFileComment()

std::string pcpp::PcapNgFileReaderDevice::getCaptureFileComment

(

)

const

The pcap-ng format allows storing metadata at the header of the file. Part of this metadata is a string containing a user-defined comment (can be any string). This method reads this string from the metadata (if exists) and returns it

Returns

The comment written inside the file if exists, or an empty string otherwise

getHardware()

std::string pcpp::PcapNgFileReaderDevice::getHardware

(

)

const

The pcap-ng format allows storing metadata at the header of the file. Part of this metadata is a string specifying the hardware that was used for capturing the packets. This method reads this string from the metadata (if exists) and returns it

Returns

The hardware string if exists, or an empty string otherwise

getNextPacket() [1/2]

bool pcpp::PcapNgFileReaderDevice::getNextPacket	(	RawPacket &	rawPacket,
		std::string &	packetComment
	)

The pcap-ng format allows storing a user-defined comment for every packet (besides the comment per-file). This method reads the next packet and the comment attached to it (if such comment exists), and returns them both

Parameters

[out]	rawPacket	A reference for an empty RawPacket where the packet will be written
[out]	packetComment	The comment attached to the packet or an empty string if no comment exists

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

getNextPacket() [2/2]

bool pcpp::PcapNgFileReaderDevice::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.

getOS()

std::string pcpp::PcapNgFileReaderDevice::getOS

(

)

const

The pcap-ng format allows storing metadata at the header of the file. Part of this metadata is a string specifying the operating system that was used for capturing the packets. This method reads this string from the metadata (if exists) and returns it

Returns

The operating system string if exists, or an empty string otherwise

getStatistics()

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

virtual

Get statistics of packets read so far.

Parameters

[out]

stats

The stats struct where stats are returned

Implements pcpp::IPcapDevice.

open()

bool pcpp::PcapNgFileReaderDevice::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.

setFilter()

bool pcpp::PcapNgFileReaderDevice::setFilter ( std::string  filterAsString )

virtual

Set a filter for PcapNG reader device. Only packets that match the filter will be received

Parameters

[in]

filterAsString

The filter to be set in Berkeley Packet Filter (BPF) syntax (http://biot.com/capstats/bpf.html)

Returns

True if filter set successfully, false otherwise

Reimplemented from pcpp::IPcapDevice.