EMANE  1.2.1
transportlayer.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014,2016 - Adjacent Link LLC, Bridgewater, New Jersey
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in
13  * the documentation and/or other materials provided with the
14  * distribution.
15  * * Neither the name of Adjacent Link LLC nor the names of its
16  * contributors may be used to endorse or promote products derived
17  * from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #include "transportlayer.h"
34 
36  NEMLayer * pImplementor,
37  PlatformServiceProvider * pPlatformService) :
38  NEMQueuedLayer{id, pPlatformService},
39  pImplementor_{pImplementor},
40  pPlatformService_{pPlatformService}
41 {}
42 
44 {}
45 
47 {
48  NEMQueuedLayer::initialize(registrar);
49 
50  pImplementor_->initialize(registrar);
51 }
52 
53 
55 {
56  pImplementor_->configure(update);
57 }
58 
59 
61 {
62  // start the queue processing thread
64 
65  pImplementor_->start();
66 }
67 
68 
70 {
71  pImplementor_->postStart();
72 }
73 
74 
76 {
77  pImplementor_->stop();
78 
79  // stop the queue processing thread
81 }
82 
83 
85 {
86  pImplementor_->destroy();
87 }
88 
90 {
91  pImplementor_->setDownstreamTransport(pDownstreamTransport);
92 }
93 
94 void EMANE::TransportLayer::doProcessConfiguration(const ConfigurationUpdate & update)
95 {
96  pImplementor_->processConfiguration(update);
97 }
98 
99 void EMANE::TransportLayer::doProcessUpstreamPacket(UpstreamPacket & pkt,
100  const ControlMessages & ctrl)
101 {
102  static_cast<UpstreamTransport *>(pImplementor_.get())->processUpstreamPacket(pkt,ctrl);
103 }
104 
105 
106 void EMANE::TransportLayer::doProcessUpstreamControl(const ControlMessages & msgs)
107 {
108  pImplementor_->processUpstreamControl(msgs);
109 }
110 
111 
112 void EMANE::TransportLayer::doProcessEvent(const EventId & eventId,
113  const Serialization & serialization)
114 {
115  pImplementor_->processEvent(eventId,serialization);
116 }
117 
118 
119 void EMANE::TransportLayer::doProcessTimedEvent(TimerEventId eventId,
120  const TimePoint & expireTime,
121  const TimePoint & scheduleTime,
122  const TimePoint & fireTime,
123  const void * arg)
124 {
125  pImplementor_->processTimedEvent(eventId,expireTime,scheduleTime,fireTime,arg);
126 }
127 
128 // method meaningless for a Transport layer
130 {}
131 
132 void EMANE::TransportLayer::doProcessDownstreamPacket(DownstreamPacket &,
133  const ControlMessages &)
134 {}
135 
136 
137 void EMANE::TransportLayer::doProcessDownstreamControl(const ControlMessages &)
138 {}
std::string Serialization
Definition: serializable.h:42
A Packet class that allows upstream processing to strip layer headers as the packet travels up the st...
The Registrar interface provides access to all of the emulator registrars.
Definition: registrar.h:50
std::list< const ControlMessage * > ControlMessages
Base class for NEMLayer containers. Builders construct NEMLayer objects to contain derived instances ...
Definition: nemlayer.h:57
std::uint16_t EventId
Definition: types.h:53
The PlatformServiceProvider interface provides access to emulator services.
void initialize(Registrar &registrar) override
void start() override
void start() override
void stop() override
void postStart() override
void stop() override
void setDownstreamTransport(DownstreamTransport *) override
void setUpstreamTransport(UpstreamTransport *) override
Specialized packet the allows downstream processing to add layer specific headers as the packet trave...
std::uint16_t NEMId
Definition: types.h:52
void configure(const ConfigurationUpdate &update) override
TransportLayer(NEMId id, NEMLayer *pImplementor, PlatformServiceProvider *pPlatformService)
void initialize(Registrar &registrar) override
std::vector< ConfigurationNameAnyValues > ConfigurationUpdate
void destroy() override
UpstreamTransport allows for processing upstream data and control messages. Upstream packets and cont...
std::size_t TimerEventId
Definition: types.h:54
Clock::time_point TimePoint
Definition: types.h:50
DownstreamTransport allows for processing downstream data and control messages.
void processUpstreamPacket(UpstreamPacket &pkt, const ControlMessages &msgs) override
A layer stack with a porcessing queue between each layer to decouple to intra queue processing...