EMANE  1.2.1
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
EMANE::UpstreamTransport Class Referenceabstract

UpstreamTransport allows for processing upstream data and control messages. Upstream packets and control messages are placed on the NEMQueuedLayer functor queue for processing. More...

#include <upstreamtransport.h>

Inheritance diagram for EMANE::UpstreamTransport:
EMANE::NEMLayer EMANE::NEMNetworkAdapter EMANE::MACLayerImplementor EMANE::NEMQueuedLayer EMANE::NEMStatefulLayer EMANE::PHYLayerImplementor EMANE::ShimLayerImplementor EMANE::Transport EMANE::Models::Bypass::MACLayer EMANE::Models::IEEE80211ABG::MACLayer EMANE::Models::RFPipe::MACLayer EMANE::Models::TDMA::BaseModel EMANE::Models::TDMA::BaseModel::Implementation EMANE::MACLayer EMANE::PHYLayer EMANE::ShimLayer EMANE::TransportLayer EMANE::FrameworkPHY EMANE::Models::Bypass::PHYLayer EMANE::Models::CommEffect::Shim EMANE::Models::PHYAPITest::ShimLayer EMANE::Models::TimingAnalysis::ShimLayer EMANE::Transports::Ethernet::EthernetTransport

Public Member Functions

virtual ~UpstreamTransport ()
 
virtual void processUpstreamPacket (UpstreamPacket &pkt, const ControlMessages &msgs=empty)=0
 
virtual void processUpstreamControl (const ControlMessages &msgs)=0
 
virtual void setDownstreamTransport (DownstreamTransport *pDownstreamTransport)
 
void sendDownstreamPacket (DownstreamPacket &pkt, const ControlMessages &msgs=empty)
 
void sendDownstreamControl (const ControlMessages &msgs)
 

Static Public Attributes

static const ControlMessages empty
 

Protected Member Functions

 UpstreamTransport ()
 

Detailed Description

UpstreamTransport allows for processing upstream data and control messages. Upstream packets and control messages are placed on the NEMQueuedLayer functor queue for processing.

Definition at line 52 of file upstreamtransport.h.

Constructor & Destructor Documentation

◆ ~UpstreamTransport()

virtual EMANE::UpstreamTransport::~UpstreamTransport ( )
inlinevirtual

Definition at line 55 of file upstreamtransport.h.

◆ UpstreamTransport()

EMANE::UpstreamTransport::UpstreamTransport ( )
inlineprotected

Definition at line 110 of file upstreamtransport.h.

Member Function Documentation

◆ processUpstreamControl()

virtual void EMANE::UpstreamTransport::processUpstreamControl ( const ControlMessages &  msgs)
pure virtual

Process upstream control message

Parameters
msgsreference to the ControlMessages

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::NEMStatefulLayer, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Transports::Virtual::VirtualTransport, EMANE::NEMQueuedLayer, EMANE::Models::Bypass::MACLayer, EMANE::Transports::Raw::RawTransport, EMANE::Models::TDMA::BaseModel, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, and EMANE::NEMNetworkAdapter.

◆ processUpstreamPacket()

virtual void EMANE::UpstreamTransport::processUpstreamPacket ( UpstreamPacket &  pkt,
const ControlMessages &  msgs = empty 
)
pure virtual

Process upstream packet

Parameters
pktreference to the UpstreamPacket to process
msgsoptional reference to the ControlMessages

Implemented in EMANE::NEMStatefulLayer, EMANE::Transports::Virtual::VirtualTransport, EMANE::NEMQueuedLayer, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Transports::Raw::RawTransport, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, and EMANE::NEMNetworkAdapter.

◆ sendDownstreamControl()

void EMANE::UpstreamTransport::sendDownstreamControl ( const ControlMessages &  msgs)
inline

Send downstream control message

Parameters
msgsreference to the ControlMessages

Definition at line 44 of file upstreamtransport.inl.

◆ sendDownstreamPacket()

void EMANE::UpstreamTransport::sendDownstreamPacket ( DownstreamPacket &  pkt,
const ControlMessages &  msgs = empty 
)
inline

Send downsteam packet

Parameters
pktreference to the DownstreamPacket to process
msgsoptional reference to the ControlMessages

Definition at line 37 of file upstreamtransport.inl.

◆ setDownstreamTransport()

virtual void EMANE::UpstreamTransport::setDownstreamTransport ( DownstreamTransport *  pDownstreamTransport)
inlinevirtual

Set the downstream transport.

Parameters
pDownstreamTransportPointer to the downstream transport of this upstream transport.
Note
: This method is for internal framework use only.

Reimplemented in EMANE::NEMStatefulLayer, EMANE::PHYLayer, EMANE::MACLayer, EMANE::ShimLayer, and EMANE::TransportLayer.

Definition at line 82 of file upstreamtransport.h.

Member Data Documentation

◆ empty

const EMANE::ControlMessages EMANE::UpstreamTransport::empty
static

Definition at line 106 of file upstreamtransport.h.

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