EMANE  1.2.1
transportlayer.h
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 #ifndef EMANETRANSPORTLAYER_HEADER_
34 #define EMANETRANSPORTLAYER_HEADER_
35 
36 #include "nemqueuedlayer.h"
37 
38 #include <memory>
39 
40 namespace EMANE
41 {
50  {
51  public:
53  NEMLayer * pImplementor,
54  PlatformServiceProvider * pPlatformService);
55 
57 
58  void initialize(Registrar & registrar) override;
59 
60  void configure(const ConfigurationUpdate & update) override;
61 
62  void start() override;
63 
64  void postStart() override;
65 
66  void stop() override;
67 
68  void destroy() throw() override;
69 
70  void setUpstreamTransport(UpstreamTransport *) override;
71 
73 
74  private:
75  std::unique_ptr<NEMLayer> pImplementor_;
76 
77  std::unique_ptr<PlatformServiceProvider> pPlatformService_;
78 
79  void doProcessConfiguration(const ConfigurationUpdate &) override;
80 
81  void doProcessDownstreamControl(const ControlMessages &) override;
82 
83  void doProcessDownstreamPacket(DownstreamPacket &,const ControlMessages &) override;
84 
85  void doProcessUpstreamPacket(UpstreamPacket &,const ControlMessages &) override;
86 
87  void doProcessUpstreamControl(const ControlMessages &) override;
88 
89  void doProcessEvent(const EventId &, const Serialization &) override;
90 
91  void doProcessTimedEvent(TimerEventId eventId,
92  const TimePoint & expireTime,
93  const TimePoint & scheduleTime,
94  const TimePoint & fireTime,
95  const void * arg) override;
96  };
97 }
98 
99 #endif //EMANETRANSPORTLAYER_HEADER_
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 stop() override
void postStart() 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
Bridge for the Transport NEM layer. Decouples a TransportLayerImplementor implementation from the NEM...
void configure(const ConfigurationUpdate &update) override
TransportLayer(NEMId id, NEMLayer *pImplementor, PlatformServiceProvider *pPlatformService)
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.
Definition: agent.h:43
A layer stack with a porcessing queue between each layer to decouple to intra queue processing...