ns3::PcapFile Class Reference

Collaboration diagram for ns3::PcapFile:

Classes
struct	PcapFileHeader
struct	PcapRecordHeader
Public Member Functions
bool	Fail (void) const
bool	Eof (void) const
void	Clear (void)
void	Open (std::string const &filename, std::ios::openmode mode)
void	Close (void)
void	Init (uint32_t dataLinkType, uint32_t snapLen=SNAPLEN_DEFAULT, int32_t timeZoneCorrection=ZONE_DEFAULT, bool swapMode=false)
void	Write (uint32_t tsSec, uint32_t tsUsec, uint8_t const *const data, uint32_t totalLen)
	Write next packet to file.
void	Write (uint32_t tsSec, uint32_t tsUsec, Ptr< const Packet > p)
	Write next packet to file.
void	Write (uint32_t tsSec, uint32_t tsUsec, Header &header, Ptr< const Packet > p)
	Write next packet to file.
void	Read (uint8_t *const data, uint32_t maxBytes, uint32_t &tsSec, uint32_t &tsUsec, uint32_t &inclLen, uint32_t &origLen, uint32_t &readLen)
	Read next packet from file.
bool	GetSwapMode (void)
	Get the swap mode of the file.
uint32_t	GetMagic (void)
uint16_t	GetVersionMajor (void)
uint16_t	GetVersionMinor (void)
int32_t	GetTimeZoneOffset (void)
uint32_t	GetSigFigs (void)
uint32_t	GetSnapLen (void)
uint32_t	GetDataLinkType (void)
Static Public Member Functions
static bool	Diff (std::string const &f1, std::string const &f2, uint32_t &sec, uint32_t &usec, uint32_t snapLen=SNAPLEN_DEFAULT)
	Compare two PCAP files packet-by-packet.
Static Public Attributes
static const int32_t	ZONE_DEFAULT = 0
static const uint32_t	SNAPLEN_DEFAULT = 65535

Member Function Documentation

void ns3::PcapFile::Clear ( void )

Clear all state bits of the underlying iostream.

void ns3::PcapFile::Close ( void )

Close the underlying file.

static bool ns3::PcapFile::Diff	(	std::string const &	f1,
		std::string const &	f2,
		uint32_t &	sec,
		uint32_t &	usec,
		uint32_t	snapLen = `SNAPLEN_DEFAULT`
	)			`[static]`

Compare two PCAP files packet-by-packet.

Returns:: true if files are different, false otherwise

Parameters:

	f1	First PCAP file name
	f2	Second PCAP file name
	sec	[out] Time stamp of first different packet, seconds. Undefined if files doesn't differ.
	usec	[out] Time stamp of first different packet, microseconds. Undefined if files doesn't differ.
	snapLen	Snap length (if used)

bool ns3::PcapFile::Eof ( void ) const

Returns:: true if the 'eof' bit is set in the underlying iostream, false otherwise.

bool ns3::PcapFile::Fail ( void ) const

Returns:: true if the 'fail' bit is set in the underlying iostream, false otherwise.

bool ns3::PcapFile::GetSwapMode ( void )

Get the swap mode of the file.

Pcap files use a magic number that is overloaded to identify both the format of the file itself and the byte ordering of the file. The magic number (and all data) is written into the file according to the native byte ordering of the writing system. If a reading application reads the magic number identically (for example 0xa1b2c3d4) then no byte swapping is required to correctly interpret the file data. If the reading application sees the magic number is byte swapped (for example 0xd4c3b2a1) then it knows that it needs to byteswap appropriate fields in the format.

GetSWapMode returns a value indicating whether or not the fields are being byteswapped. Used primarily for testing the class itself, but may be useful as a flag indicating a difference in endianness of the writing system.

void ns3::PcapFile::Init	(	uint32_t	dataLinkType,
		uint32_t	snapLen = `SNAPLEN_DEFAULT`,
		int32_t	timeZoneCorrection = `ZONE_DEFAULT`,
		bool	swapMode = `false`
	)

Initialize the pcap file associated with this object. This file must have been previously opened with write permissions.

Parameters:

	dataLinkType	A data link type as defined in the pcap library. If you want to make resulting pcap files visible in existing tools, the data link type must match existing definitions, such as PCAP_ETHERNET, PCAP_PPP, PCAP_80211, etc. If you are storing different kinds of packet data, such as naked TCP headers, you are at liberty to locally define your own data link types. According to the pcap-linktype man page, "well-known" pcap linktypes range from 0 to 177. If you use a large random number for your type, chances are small for a collision.
	snapLen	An optional maximum size for packets written to the file. Defaults to 65535. If packets exceed this length they are truncated.
	timeZoneCorrection	An integer describing the offset of your local time zone from UTC/GMT. For example, Pacific Standard Time in the US is GMT-8, so one would enter -8 for that correction. Defaults to 0 (UTC).
	swapMode	Flag indicating a difference in endianness of the writing system. Defaults to false.

Returns:: false if the open succeeds, true otherwise.

Warning:: Calling this method on an existing file will result in the loss any existing data.

void ns3::PcapFile::Open	(	std::string const &	filename,
		std::ios::openmode	mode
	)

Create a new pcap file or open an existing pcap file. Semantics are similar to the stdc++ io stream classes, but differ in that positions in the file are based on packets not characters. For example if the file is opened for reading, the file position indicator (seek position) points to the beginning of the first packet in the file, not zero (which would point to the start of the pcap header).

Since a pcap file is always a binary file, the file type is automatically selected as a binary file (fstream::binary is automatically ored with the mode field).

Parameters:

	filename	String containing the name of the file.
	mode	the access mode for the file.

void ns3::PcapFile::Read	(	uint8_t *const	data,
		uint32_t	maxBytes,
		uint32_t &	tsSec,
		uint32_t &	tsUsec,
		uint32_t &	inclLen,
		uint32_t &	origLen,
		uint32_t &	readLen
	)

Member Data Documentation

const uint32_t ns3::PcapFile::SNAPLEN_DEFAULT = 65535 [static]

Default value for maximum octets to save per packet

const int32_t ns3::PcapFile::ZONE_DEFAULT = 0 [static]

Time zone offset for current location

The documentation for this class was generated from the following file:

src/common/pcap-file.h

	tsSec	Packet timestamp, seconds
	tsUsec	Packet timestamp, microseconds
	header	Header to write, in front of packet
	p	Packet to write

	tsSec	Packet timestamp, seconds
	tsUsec	Packet timestamp, microseconds
	p	Packet to write

	tsSec	Packet timestamp, seconds
	tsUsec	Packet timestamp, microseconds
	data	Data buffer
	totalLen	Total packet length

	data	[out] Data buffer
	maxBytes	Allocated data buffer size
	tsSec	[out] Packet timestamp, seconds
	tsUsec	[out] Packet timestamp, microseconds
	inclLen	[out] Included length
	origLen	[out] Original length
	readLen	[out] Number of bytes read

void ns3::PcapFile::Write	(	uint32_t	tsSec,
		uint32_t	tsUsec,
		Header &	header,
		Ptr< const Packet >	p
	)

ns3::PcapFile Class Reference

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Member Function Documentation

Member Data Documentation