A Discrete-Event Network Simulator
API
ns3::PointToPointRemoteChannel Class Reference

A Remote Point-To-Point Channel. More...

#include "point-to-point-remote-channel.h"

+ Inheritance diagram for ns3::PointToPointRemoteChannel:
+ Collaboration diagram for ns3::PointToPointRemoteChannel:

Public Member Functions

 PointToPointRemoteChannel ()
 Constructor. More...
 
 ~PointToPointRemoteChannel ()
 Deconstructor. More...
 
virtual bool TransmitStart (Ptr< const Packet > p, Ptr< PointToPointNetDevice > src, Time txTime)
 Transmit the packet. More...
 
- Public Member Functions inherited from ns3::PointToPointChannel
 PointToPointChannel ()
 Create a PointToPointChannel. More...
 
void Attach (Ptr< PointToPointNetDevice > device)
 Attach a given netdevice to this channel. More...
 
virtual Ptr< NetDeviceGetDevice (std::size_t i) const
 Get NetDevice corresponding to index i on this channel. More...
 
virtual std::size_t GetNDevices (void) const
 Get number of devices on this channel. More...
 
Ptr< PointToPointNetDeviceGetPointToPointDevice (std::size_t i) const
 Get PointToPointNetDevice corresponding to index i on this channel. More...
 
- Public Member Functions inherited from ns3::Channel
 Channel ()
 
virtual ~Channel ()
 
uint32_t GetId (void) const
 
- 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<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] 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 TypeId. More...
 
- Static Public Member Functions inherited from ns3::PointToPointChannel
static TypeId GetTypeId (void)
 Get the TypeId. More...
 
- Static Public Member Functions inherited from ns3::Channel
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...
 

Additional Inherited Members

- Protected Types inherited from ns3::PointToPointChannel
typedef void(* TxRxAnimationCallback) (Ptr< const Packet > packet, Ptr< NetDevice > txDevice, Ptr< NetDevice > rxDevice, Time duration, Time lastBitTime)
 TracedCallback signature for packet transmission animation events. More...
 
- Protected Member Functions inherited from ns3::PointToPointChannel
Time GetDelay (void) const
 Get the delay associated with this channel. More...
 
Ptr< PointToPointNetDeviceGetDestination (uint32_t i) const
 Get the net-device destination. More...
 
Ptr< PointToPointNetDeviceGetSource (uint32_t i) const
 Get the net-device source. More...
 
bool IsInitialized (void) const
 Check to make sure the link is initialized. More...
 
- 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...
 

Detailed Description

A Remote Point-To-Point Channel.

This object connects two point-to-point net devices where at least one is not local to this simulator object. It simply override the transmit method and uses an MPI Send operation instead.

Definition at line 41 of file point-to-point-remote-channel.h.

Constructor & Destructor Documentation

◆ PointToPointRemoteChannel()

ns3::PointToPointRemoteChannel::PointToPointRemoteChannel ( )

Constructor.

Definition at line 47 of file point-to-point-remote-channel.cc.

◆ ~PointToPointRemoteChannel()

ns3::PointToPointRemoteChannel::~PointToPointRemoteChannel ( )

Deconstructor.

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

Member Function Documentation

◆ GetTypeId()

TypeId ns3::PointToPointRemoteChannel::GetTypeId ( void  )
static

Get the TypeId.

Returns
The TypeId for this class

Definition at line 37 of file point-to-point-remote-channel.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ TransmitStart()

bool ns3::PointToPointRemoteChannel::TransmitStart ( Ptr< const Packet p,
Ptr< PointToPointNetDevice src,
Time  txTime 
)
virtual

Transmit the packet.

Parameters
pPacket to transmit
srcSource PointToPointNetDevice
txTimeTransmit time to apply
Returns
true if successful (currently always true)

Reimplemented from ns3::PointToPointChannel.

Definition at line 57 of file point-to-point-remote-channel.cc.

References ns3::Packet::Copy(), ns3::PointToPointChannel::GetDelay(), ns3::PointToPointChannel::GetDestination(), ns3::PointToPointChannel::GetSource(), ns3::Packet::GetUid(), ns3::PointToPointChannel::IsInitialized(), ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::MpiInterface::SendPacket().

+ Here is the call graph for this function:

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