A class that wraps a PcapFile as an ns3::Object and provides a higher-layer ns-3 interface to the low-level public methods of PcapFile. More...

#include "pcap-file-wrapper.h"

Inheritance diagram for ns3::PcapFileWrapper:

Public Member Functions
	PcapFileWrapper ()

	~PcapFileWrapper ()

void	Clear (void)
	Clear all state bits of the underlying iostream. More...

void	Close (void)
	Close the underlying pcap file. More...

bool	Eof (void) const

bool	Fail (void) const

uint32_t	GetDataLinkType (void)
	Returns the data link type field of the pcap file as defined by the network field in the pcap global header. More...

uint32_t	GetMagic (void)
	Returns the magic number of the pcap file as defined by the magic_number field in the pcap global header. More...

uint32_t	GetSigFigs (void)
	Returns the accuracy of timestamps field of the pcap file as defined by the sigfigs field in the pcap global header. More...

uint32_t	GetSnapLen (void)
	Returns the max length of saved packets field of the pcap file as defined by the snaplen field in the pcap global header. More...

int32_t	GetTimeZoneOffset (void)
	Returns the time zone offset of the pcap file as defined by the thiszone field in the pcap global header. More...

uint16_t	GetVersionMajor (void)
	Returns the major version of the pcap file as defined by the version_major field in the pcap global header. More...

uint16_t	GetVersionMinor (void)
	Returns the minor version of the pcap file as defined by the version_minor field in the pcap global header. More...

void	Init (uint32_t dataLinkType, uint32_t snapLen=std::numeric_limits< uint32_t >::max(), int32_t tzCorrection=PcapFile::ZONE_DEFAULT)
	Initialize the pcap file associated with this wrapper. More...

void	Open (std::string const &filename, std::ios::openmode mode)
	Create a new pcap file or open an existing pcap file. More...

Ptr< Packet >	Read (Time &t)
	Read the next packet from the file. More...

void	Write (Time t, Ptr< const Packet > p)
	Write the next packet to file. More...

void	Write (Time t, const Header &header, Ptr< const Packet > p)
	Write the provided header along with the packet to the pcap file. More...

void	Write (Time t, uint8_t const *buffer, uint32_t length)
	Write the provided data buffer to the pcap file. More...

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

virtual	~Object ()
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose (void)
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized (void) const
	Check if the object has been initialized. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Attributes
PcapFile	m_file
	Pcap file. More...

bool	m_nanosecMode
	Timestamps in nanosecond mode. More...

uint32_t	m_snapLen
	max length of saved packets More...

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoDispose (void)
	Destructor implementation. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

virtual void	NotifyNewAggregate (void)
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

A class that wraps a PcapFile as an ns3::Object and provides a higher-layer ns-3 interface to the low-level public methods of PcapFile.

Introspection did not find any typical Config paths.

Users are encouraged to use this object instead of class ns3::PcapFile in ns-3 public APIs.

Attributes

CaptureSize: Maximum length of captured packets (cf. pcap snaplen)
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:65535
- Initial value: 65535
- Flags: construct write read
NanosecMode: Whether packet timestamps in the PCAP file are nanoseconds or microseconds(default).
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read

No TraceSources are defined for this type.
Size of this type is 680 bytes (on a 64-bit architecture).

Definition at line 39 of file pcap-file-wrapper.h.

Constructor & Destructor Documentation

◆ PcapFileWrapper()

ns3::PcapFileWrapper::PcapFileWrapper ( )

Definition at line 54 of file pcap-file-wrapper.cc.

References NS_LOG_FUNCTION.

◆ ~PcapFileWrapper()

ns3::PcapFileWrapper::~PcapFileWrapper ( )

Definition at line 59 of file pcap-file-wrapper.cc.

References Close(), and NS_LOG_FUNCTION.

Member Function Documentation

◆ Clear()

void ns3::PcapFileWrapper::Clear ( void )

Clear all state bits of the underlying iostream.

Definition at line 79 of file pcap-file-wrapper.cc.

References ns3::PcapFile::Clear(), m_file, and NS_LOG_FUNCTION.

◆ Close()

void ns3::PcapFileWrapper::Close ( void )

Close the underlying pcap file.

Definition at line 86 of file pcap-file-wrapper.cc.

References ns3::PcapFile::Close(), m_file, and NS_LOG_FUNCTION.

Referenced by ~PcapFileWrapper().

◆ Eof()

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

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

Definition at line 73 of file pcap-file-wrapper.cc.

References ns3::PcapFile::Eof(), m_file, and NS_LOG_FUNCTION.

◆ Fail()

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

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

Definition at line 66 of file pcap-file-wrapper.cc.

References ns3::PcapFile::Fail(), m_file, and NS_LOG_FUNCTION.

◆ GetDataLinkType()

uint32_t ns3::PcapFileWrapper::GetDataLinkType ( void )

Returns the data link type field of the pcap file as defined by the network field in the pcap global header.

See http://wiki.wireshark.org/Development/LibpcapFileFormat

Returns: data link type field

Definition at line 253 of file pcap-file-wrapper.cc.

References ns3::PcapFile::GetDataLinkType(), m_file, and NS_LOG_FUNCTION.

◆ GetMagic()

uint32_t ns3::PcapFileWrapper::GetMagic ( void )

Returns the magic number of the pcap file as defined by the magic_number field in the pcap global header.

See http://wiki.wireshark.org/Development/LibpcapFileFormat

Returns: magic number

Definition at line 211 of file pcap-file-wrapper.cc.

References ns3::PcapFile::GetMagic(), m_file, and NS_LOG_FUNCTION.

◆ GetSigFigs()

uint32_t ns3::PcapFileWrapper::GetSigFigs ( void )

Returns the accuracy of timestamps field of the pcap file as defined by the sigfigs field in the pcap global header.

See http://wiki.wireshark.org/Development/LibpcapFileFormat

Returns: accuracy of timestamps

Definition at line 239 of file pcap-file-wrapper.cc.

References ns3::PcapFile::GetSigFigs(), m_file, and NS_LOG_FUNCTION.

◆ GetSnapLen()

uint32_t ns3::PcapFileWrapper::GetSnapLen ( void )

Returns the max length of saved packets field of the pcap file as defined by the snaplen field in the pcap global header.

See http://wiki.wireshark.org/Development/LibpcapFileFormat

Returns: max length of saved packets field

Definition at line 246 of file pcap-file-wrapper.cc.

References ns3::PcapFile::GetSnapLen(), m_file, and NS_LOG_FUNCTION.

◆ GetTimeZoneOffset()

int32_t ns3::PcapFileWrapper::GetTimeZoneOffset ( void )

Returns the time zone offset of the pcap file as defined by the thiszone field in the pcap global header.

See http://wiki.wireshark.org/Development/LibpcapFileFormat

Returns: time zone offset

Definition at line 232 of file pcap-file-wrapper.cc.

References ns3::PcapFile::GetTimeZoneOffset(), m_file, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::PcapFileWrapper::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 33 of file pcap-file-wrapper.cc.

References m_nanosecMode, m_snapLen, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeUintegerAccessor(), ns3::TypeId::SetParent(), and ns3::PcapFile::SNAPLEN_DEFAULT.

◆ GetVersionMajor()

uint16_t ns3::PcapFileWrapper::GetVersionMajor ( void )

Returns the major version of the pcap file as defined by the version_major field in the pcap global header.

See http://wiki.wireshark.org/Development/LibpcapFileFormat

Returns: major version

Definition at line 218 of file pcap-file-wrapper.cc.

References ns3::PcapFile::GetVersionMajor(), m_file, and NS_LOG_FUNCTION.

◆ GetVersionMinor()

uint16_t ns3::PcapFileWrapper::GetVersionMinor ( void )

Returns the minor version of the pcap file as defined by the version_minor field in the pcap global header.

See http://wiki.wireshark.org/Development/LibpcapFileFormat

Returns: minor version

Definition at line 225 of file pcap-file-wrapper.cc.

References ns3::PcapFile::GetVersionMinor(), m_file, and NS_LOG_FUNCTION.

◆ Init()

void ns3::PcapFileWrapper::Init	(	uint32_t	dataLinkType,
		uint32_t	snapLen = `std::numeric_limits<uint32_t>::max ()`,
		int32_t	tzCorrection = `PcapFile::ZONE_DEFAULT`
	)

Initialize the pcap file associated with this wrapper.

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.
tzCorrection	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).

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

Definition at line 100 of file pcap-file-wrapper.cc.

References ns3::PcapFile::Init(), m_file, m_nanosecMode, m_snapLen, max, and NS_LOG_FUNCTION.

◆ Open()

void ns3::PcapFileWrapper::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.

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	String containing the access mode for the file.

Definition at line 93 of file pcap-file-wrapper.cc.

References m_file, NS_LOG_FUNCTION, and ns3::PcapFile::Open().

◆ Read()

Ptr< Packet > ns3::PcapFileWrapper::Read ( Time & t )

Read the next packet from the file.

Parameters

t	Reference to packet timestamp as ns3::Time.

Returns: a pointer to ns3::Packet.

Definition at line 179 of file pcap-file-wrapper.cc.

References ns3::PcapFile::Fail(), ns3::PcapFile::IsNanoSecMode(), m_file, ns3::MicroSeconds(), ns3::NanoSeconds(), and ns3::PcapFile::Read().

◆ Write() [1/3]

void ns3::PcapFileWrapper::Write	(	Time	t,
		Ptr< const Packet >	p
	)

Write the next packet to file.

Parameters

t	Packet timestamp as ns3::Time.
p	Packet to write to the pcap file.

Definition at line 119 of file pcap-file-wrapper.cc.

References ns3::Time::GetMicroSeconds(), ns3::Time::GetNanoSeconds(), ns3::PcapFile::IsNanoSecMode(), m_file, NS_LOG_FUNCTION, and ns3::PcapFile::Write().

◆ Write() [2/3]

void ns3::PcapFileWrapper::Write	(	Time	t,
		const Header &	header,
		Ptr< const Packet >	p
	)

Write the provided header along with the packet to the pcap file.

It is the case that adding a header to a packet prior to writing it to a file must trigger a deep copy in the Packet. By providing the header separately, we can avoid that copy.

Parameters

t	Packet timestamp as ns3::Time.
header	The Header to prepend to the packet.
p	Packet to write to the pcap file.

Definition at line 139 of file pcap-file-wrapper.cc.

References ns3::Time::GetMicroSeconds(), ns3::Time::GetNanoSeconds(), ns3::PcapFile::IsNanoSecMode(), m_file, NS_LOG_FUNCTION, and ns3::PcapFile::Write().

◆ Write() [3/3]

void ns3::PcapFileWrapper::Write	(	Time	t,
		uint8_t const *	buffer,
		uint32_t	length
	)

Write the provided data buffer to the pcap file.

Parameters

t	Packet timestamp as ns3::Time.
buffer	The buffer to write.
length	The size of the buffer.

Definition at line 159 of file pcap-file-wrapper.cc.

References ns3::Time::GetMicroSeconds(), ns3::Time::GetNanoSeconds(), ns3::PcapFile::IsNanoSecMode(), m_file, NS_LOG_FUNCTION, and ns3::PcapFile::Write().

Member Data Documentation

◆ m_file

PcapFile ns3::PcapFileWrapper::m_file

private

Pcap file.

Definition at line 224 of file pcap-file-wrapper.h.

Referenced by Clear(), Close(), Eof(), Fail(), GetDataLinkType(), GetMagic(), GetSigFigs(), GetSnapLen(), GetTimeZoneOffset(), GetVersionMajor(), GetVersionMinor(), Init(), Open(), Read(), and Write().

◆ m_nanosecMode

bool ns3::PcapFileWrapper::m_nanosecMode

private

Timestamps in nanosecond mode.

Definition at line 226 of file pcap-file-wrapper.h.

Referenced by GetTypeId(), and Init().

◆ m_snapLen

uint32_t ns3::PcapFileWrapper::m_snapLen

private

max length of saved packets

Definition at line 225 of file pcap-file-wrapper.h.

Referenced by GetTypeId(), and Init().

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

src/network/utils/pcap-file-wrapper.h
src/network/utils/pcap-file-wrapper.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Attributes

Constructor & Destructor Documentation

◆ PcapFileWrapper()

◆ ~PcapFileWrapper()

Member Function Documentation

◆ Clear()

◆ Close()

◆ Eof()

◆ Fail()

◆ GetDataLinkType()

◆ GetMagic()

◆ GetSigFigs()

◆ GetSnapLen()

◆ GetTimeZoneOffset()

◆ GetTypeId()

◆ GetVersionMajor()

◆ GetVersionMinor()

◆ Init()

◆ Open()

◆ Read()

◆ Write() [1/3]

◆ Write() [2/3]

◆ Write() [3/3]

Member Data Documentation

◆ m_file

◆ m_nanosecMode

◆ m_snapLen