Simple Point To Point Channel. More...

#include <point-to-point-channel.h>

Inheritance diagram for ns3::PointToPointChannel:

Collaboration diagram for ns3::PointToPointChannel:

Classes
class	Link

Public Member Functions
	PointToPointChannel ()
	Create a PointToPointChannel.
void	Attach (Ptr< PointToPointNetDevice > device)
	Attach a given netdevice to this channel.
virtual Ptr< NetDevice >	GetDevice (uint32_t i) const
virtual uint32_t	GetNDevices (void) const
	Get number of devices on this channel.
Ptr< PointToPointNetDevice >	GetPointToPointDevice (uint32_t i) const
virtual bool	TransmitStart (Ptr< Packet > p, Ptr< PointToPointNetDevice > src, Time txTime)
	Transmit a packet over this channel.
Public Member Functions inherited from ns3::Channel
	Channel ()
virtual	~Channel ()
uint32_t	GetId (void) const
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~Object ()
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
AggregateIterator	GetAggregateIterator (void) const
virtual TypeId	GetInstanceTypeId (void) const
template<typename T >
Ptr< T >	GetObject (void) const
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
void	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
void	GetAttribute (std::string name, AttributeValue &value) const
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::PointToPointChannel.

Protected Member Functions
Time	GetDelay (void) const
Ptr< PointToPointNetDevice >	GetDestination (uint32_t i) const
Ptr< PointToPointNetDevice >	GetSource (uint32_t i) const
bool	IsInitialized (void) const

Private Types
enum	WireState { INITIALIZING, IDLE, TRANSMITTING, PROPAGATING }

Private Attributes
Time	m_delay
Link	m_link [N_DEVICES]
int32_t	m_nDevices
TracedCallback< Ptr< const Packet >, Ptr< NetDevice > , Ptr< NetDevice >, Time, Time >	m_txrxPointToPoint

Static Private Attributes
static const int	N_DEVICES = 2

Detailed Description

Simple Point To Point Channel.

This class represents a very simple point to point channel. Think full duplex RS-232 or RS-422 with null modem and no handshaking. There is no multi-drop capability on this channel – there can be a maximum of two point-to-point net devices connected.

There are two "wires" in the channel. The first device connected gets the [0] wire to transmit on. The second device gets the [1] wire. There is a state (IDLE, TRANSMITTING) associated with each wire.

Definition at line 47 of file point-to-point-channel.h.

Member Enumeration Documentation

enum ns3::PointToPointChannel::WireState

private

Enumerator:

INITIALIZING
IDLE
TRANSMITTING
PROPAGATING

Definition at line 147 of file point-to-point-channel.h.

Constructor & Destructor Documentation

ns3::PointToPointChannel::PointToPointChannel ( )

Create a PointToPointChannel.

By default, you get a channel that has zero transmission delay.

Definition at line 52 of file point-to-point-channel.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

void ns3::PointToPointChannel::Attach ( Ptr< PointToPointNetDevice > device )

Attach a given netdevice to this channel.

Parameters

device pointer to the netdevice to attach to the channel

Definition at line 62 of file point-to-point-channel.cc.

References IDLE, ns3::PointToPointChannel::Link::m_dst, m_link, m_nDevices, ns3::PointToPointChannel::Link::m_src, ns3::PointToPointChannel::Link::m_state, N_DEVICES, NS_ASSERT, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by ns3::PointToPointNetDevice::Attach(), and ns3::PointToPointTest::DoRun().

Here is the caller graph for this function:

Time ns3::PointToPointChannel::GetDelay ( void ) const

protected

Definition at line 128 of file point-to-point-channel.cc.

References m_delay.

Ptr< PointToPointNetDevice > ns3::PointToPointChannel::GetDestination ( uint32_t i ) const

protected

Definition at line 140 of file point-to-point-channel.cc.

References ns3::PointToPointChannel::Link::m_dst, and m_link.

Ptr< NetDevice > ns3::PointToPointChannel::GetDevice ( uint32_t i ) const

virtual

Parameters

i	index of NetDevice to retrieve

Returns: one of the NetDevices connected to this channel.

This method must be implemented by subclasses.

Implements ns3::Channel.

Definition at line 121 of file point-to-point-channel.cc.

References GetPointToPointDevice(), and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::PointToPointNetDevice::GetRemote().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::PointToPointChannel::GetNDevices ( void ) const

virtual

Get number of devices on this channel.

Returns: number of devices on this channel

Implements ns3::Channel.

Definition at line 106 of file point-to-point-channel.cc.

References m_nDevices, and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::PointToPointNetDevice::GetRemote().

Here is the caller graph for this function:

Ptr< PointToPointNetDevice > ns3::PointToPointChannel::GetPointToPointDevice ( uint32_t i ) const

Definition at line 113 of file point-to-point-channel.cc.

References m_link, ns3::PointToPointChannel::Link::m_src, NS_ASSERT, and NS_LOG_FUNCTION_NOARGS.

Referenced by GetDevice().

Here is the caller graph for this function:

Ptr< PointToPointNetDevice > ns3::PointToPointChannel::GetSource ( uint32_t i ) const

protected

Definition at line 134 of file point-to-point-channel.cc.

References m_link, and ns3::PointToPointChannel::Link::m_src.

TypeId ns3::PointToPointChannel::GetTypeId ( void )

static

This method returns the TypeId associated to ns3::PointToPointChannel.

Attributes defined for this type:

Delay: Transmission delay through the channel
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +0.0ns
- Flags: construct write read

Attributes defined in parent class ns3::Channel:

Id: The id (unique integer) of this Channel.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Flags: read

TraceSources defined for this type:

TxRxPointToPoint: Trace source indicating transmission of packet from the PointToPointChannel, used by the Animation interface.

Reimplemented from ns3::Channel.

Reimplemented in ns3::PointToPointRemoteChannel.

Definition at line 33 of file point-to-point-channel.cc.

References m_delay, m_txrxPointToPoint, ns3::MakeTraceSourceAccessor(), ns3::Seconds(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

bool ns3::PointToPointChannel::IsInitialized ( void ) const

protected

Definition at line 146 of file point-to-point-channel.cc.

References INITIALIZING, m_link, and NS_ASSERT.

bool ns3::PointToPointChannel::TransmitStart	(	Ptr< Packet >	p,
		Ptr< PointToPointNetDevice >	src,
		Time	txTime
	)

virtual

Transmit a packet over this channel.

Parameters

p	Packet to transmit
src	Source PointToPointNetDevice
txTime	Transmit time to apply

Returns: true if successful (currently always true)

Reimplemented in ns3::PointToPointRemoteChannel.

Definition at line 83 of file point-to-point-channel.cc.

References ns3::Packet::GetUid(), INITIALIZING, m_delay, ns3::PointToPointChannel::Link::m_dst, m_link, ns3::PointToPointChannel::Link::m_src, m_txrxPointToPoint, NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::PointToPointNetDevice::Receive(), and ns3::Simulator::ScheduleWithContext().

Referenced by ns3::PointToPointNetDevice::TransmitStart().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Time ns3::PointToPointChannel::m_delay

private

Definition at line 128 of file point-to-point-channel.h.

Referenced by GetDelay(), GetTypeId(), and TransmitStart().

Link ns3::PointToPointChannel::m_link[N_DEVICES]

private

Definition at line 164 of file point-to-point-channel.h.

Referenced by Attach(), GetDestination(), GetPointToPointDevice(), GetSource(), IsInitialized(), and TransmitStart().

int32_t ns3::PointToPointChannel::m_nDevices

private

Definition at line 129 of file point-to-point-channel.h.

Referenced by Attach(), and GetNDevices().

TracedCallback<Ptr<const Packet>, Ptr<NetDevice>, Ptr<NetDevice>, Time, Time > ns3::PointToPointChannel::m_txrxPointToPoint

private

The trace source for the packet transmission animation events that the device can fire. Arguments to the callback are the packet, transmitting net device, receiving net device, transmission time and packet receipt time.

See Also: class CallBackTraceSource

Definition at line 145 of file point-to-point-channel.h.

Referenced by GetTypeId(), and TransmitStart().

const int ns3::PointToPointChannel::N_DEVICES = 2

staticprivate

Definition at line 126 of file point-to-point-channel.h.

Referenced by Attach().

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

src/point-to-point/model/point-to-point-channel.h
doc/introspected-doxygen.h
src/point-to-point/model/point-to-point-channel.cc

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation