ns3::PcapHelperForDevice Class Reference

Base class providing common user-level pcap operations for helpers representing net devices. More...

#include <trace-helper.h>

Inheritance diagram for ns3::PcapHelperForDevice:

[legend]

List of all members.

Public Member Functions
	PcapHelperForDevice ()
	Construct a PcapHelperForDevice.
virtual	~PcapHelperForDevice ()
	Destroy a PcapHelperForDevice.
virtual void	EnablePcapInternal (std::string prefix, Ptr< NetDevice > nd, bool promiscuous, bool explicitFilename)=0
	Enable pcap output the indicated net device.
void	EnablePcap (std::string prefix, Ptr< NetDevice > nd, bool promiscuous=false, bool explicitFilename=false)
	Enable pcap output the indicated net device.
void	EnablePcap (std::string prefix, std::string ndName, bool promiscuous=false, bool explicitFilename=false)
	Enable pcap output the indicated net device using a device previously named using the ns-3 object name service.
void	EnablePcap (std::string prefix, NetDeviceContainer d, bool promiscuous=false)
	Enable pcap output on each device in the container which is of the appropriate type.
void	EnablePcap (std::string prefix, NodeContainer n, bool promiscuous=false)
	Enable pcap output on each device (which is of the appropriate type) in the nodes provided in the container.
void	EnablePcap (std::string prefix, uint32_t nodeid, uint32_t deviceid, bool promiscuous=false)
	Enable pcap output on the device specified by a global node-id (of a previously created node) and associated device-id.
void	EnablePcapAll (std::string prefix, bool promiscuous=false)
	Enable pcap output on each device (which is of the appropriate type) in the set of all nodes created in the simulation.

---

Detailed Description

Base class providing common user-level pcap operations for helpers representing net devices.

---

Member Function Documentation

void ns3::PcapHelperForDevice::EnablePcap	(	std::string	prefix,
		uint32_t	nodeid,
		uint32_t	deviceid,
		bool	promiscuous = false
	)

Enable pcap output on the device specified by a global node-id (of a previously created node) and associated device-id.

Parameters:

	prefix	Filename prefix to use for pcap files.
	nodeid	the node id
	deviceid	the device id
	promiscuous	If true capture all possible packets available at the device.

void ns3::PcapHelperForDevice::EnablePcap	(	std::string	prefix,
		NodeContainer	n,
		bool	promiscuous = false
	)

Enable pcap output on each device (which is of the appropriate type) in the nodes provided in the container.

Parameters:

	prefix	Filename prefix to use for pcap files.
	n	container of nodes.
	promiscuous	If true capture all possible packets available at the device.

void ns3::PcapHelperForDevice::EnablePcap	(	std::string	prefix,
		NetDeviceContainer	d,
		bool	promiscuous = false
	)

Enable pcap output on each device in the container which is of the appropriate type.

Parameters:

	prefix	Filename prefix to use for pcap files.
	d	container of devices of type ns3::CsmaNetDevice
	promiscuous	If true capture all possible packets available at the device.

void ns3::PcapHelperForDevice::EnablePcap	(	std::string	prefix,
		std::string	ndName,
		bool	promiscuous = false,
		bool	explicitFilename = false
	)

Enable pcap output the indicated net device using a device previously named using the ns-3 object name service.

Parameters:

	prefix	filename prefix to use for pcap files.
	ndName	The name of the net device in which you want to enable tracing.
	promiscuous	If true capture all possible packets available at the device.
	explicitFilename	Treat the prefix as an explicit filename if true

void ns3::PcapHelperForDevice::EnablePcap	(	std::string	prefix,
		Ptr< NetDevice >	nd,
		bool	promiscuous = false,
		bool	explicitFilename = false
	)

Enable pcap output the indicated net device.

Parameters:

	prefix	Filename prefix to use for pcap files.
	nd	Net device for which you want to enable tracing.
	promiscuous	If true capture all possible packets available at the device.
	explicitFilename	Treat the prefix as an explicit filename if true

void ns3::PcapHelperForDevice::EnablePcapAll	(	std::string	prefix,
		bool	promiscuous = false
	)

Enable pcap output on each device (which is of the appropriate type) in the set of all nodes created in the simulation.

Parameters:

	prefix	Filename prefix to use for pcap files.
	promiscuous	If true capture all possible packets available at the device.

---

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

• src/helper/trace-helper.h