EMANE  1.2.1
shim.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-2014 - Adjacent Link LLC, Bridgewater, New Jersey
3  * Copyright (c) 2009-2010 - DRS CenGen, LLC, Columbia, Maryland
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  * * Neither the name of DRS CenGen, LLC nor the names of its
17  * contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef EMANEMODELSCOMMEFFECTSHIM_HEADER_
35 #define EMANEMODELSCOMMEFFECTSHIM_HEADER_
36 
37 #include "emane/shimlayerimpl.h"
38 
41 
42 #include "profilemanager.h"
43 
44 #include <random>
45 
46 namespace EMANE
47 {
48  namespace Models
49  {
50  namespace CommEffect
51  {
52  class Shim : public ShimLayerImplementor
53  {
54 
55  public:
56  Shim(NEMId id,
57  PlatformServiceProvider * pPlatformService,
58  RadioServiceProvider * pRadioService);
59 
60  ~Shim() override;
61 
62  void initialize(Registrar & registrar) override;
63 
64  void configure(const ConfigurationUpdate & update) override;
65 
66  void start() override;
67 
68  void stop() override;
69 
70  void destroy() throw() override;
71 
72  void processUpstreamControl(const ControlMessages & msgs) override;
73 
74  void processDownstreamControl(const ControlMessages & msgs) override;
75 
77  const ControlMessages & msgs) override;
78 
80  const ControlMessages & msgs) override;
81 
82  void processEvent(const EventId &,
83  const Serialization &) override;
84 
85  void processTimedEvent(TimerEventId eventId,
86  const TimePoint & expireTime,
87  const TimePoint & scheduleTime,
88  const TimePoint & fireTime,
89  const void * arg) override;
90 
91 
92  private:
93  using EORTimeMap = std::map<NEMId, TimePoint>;
94 
95  ProfileManager profileManager_;
96 
97  std::uint32_t u32UpstreamSequenceNumber_;
98 
99  std::uint32_t u32DownstreamSequenceNumber_;
100 
101  bool bDefaultConnectivity_;
102 
103  bool bEnablePromiscousMode_;
104 
105  bool bEnableTightTimingMode_;
106 
107  std::uint32_t u32GroupId_;
108 
109  EORTimeMap EORTimeMap_;
110 
111  Microseconds receiveBufferPeriod_;
112 
113  std::string sFilterFile_;
114 
115  Utils::RandomNumberDistribution<std::mt19937,
116  std::uniform_real_distribution<float>> RNDZeroToOneHundred_;
117 
118  std::mt19937 RNG_;
119 
120  Utils::CommonLayerStatistics commonLayerStatistics_;
121 
122  Microseconds randomize(const Microseconds & duration);
123 
124  size_t getTaskCount(float fLoss, float fDups);
125 
126  void setEORTime (NEMId src, const TimePoint & tvEORTime);
127 
128  std::pair<TimePoint,bool> getEORTime(NEMId src);
129  };
130  }
131  }
132 }
133 
134 #endif // EMANEMODELSCOMMEFFECTSHIM_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...
void processUpstreamControl(const ControlMessages &msgs) override
Definition: shim.cc:296
The Registrar interface provides access to all of the emulator registrars.
Definition: registrar.h:50
void start() override
Definition: shim.cc:252
void destroy() override
Definition: shim.cc:284
Shim(NEMId id, PlatformServiceProvider *pPlatformService, RadioServiceProvider *pRadioService)
Definition: shim.cc:86
std::list< const ControlMessage * > ControlMessages
void processDownstreamControl(const ControlMessages &msgs) override
Definition: shim.cc:307
Common NEM layer statistics and drop reason tables.
void stop() override
Definition: shim.cc:270
std::uint16_t EventId
Definition: types.h:53
The PlatformServiceProvider interface provides access to emulator services.
Interface used to create a Shim layer plugin implementation.
Definition: shimlayerimpl.h:47
void processEvent(const EventId &, const Serialization &) override
Definition: shim.cc:636
void processDownstreamPacket(DownstreamPacket &pkt, const ControlMessages &msgs) override
Definition: shim.cc:585
Specialized packet the allows downstream processing to add layer specific headers as the packet trave...
std::chrono::microseconds Microseconds
Definition: types.h:45
std::uint16_t NEMId
Definition: types.h:52
The RadioServiceProvider interface provides access to radio (RF) model specific services.
void initialize(Registrar &registrar) override
Definition: shim.cc:107
std::vector< ConfigurationNameAnyValues > ConfigurationUpdate
void processTimedEvent(TimerEventId eventId, const TimePoint &expireTime, const TimePoint &scheduleTime, const TimePoint &fireTime, const void *arg) override
Definition: shim.cc:661
union EtherAddr src
Definition: netutils.h:391
std::size_t TimerEventId
Definition: types.h:54
Clock::time_point TimePoint
Definition: types.h:50
void configure(const ConfigurationUpdate &update) override
Definition: shim.cc:168
void processUpstreamPacket(UpstreamPacket &pkt, const ControlMessages &msgs) override
Definition: shim.cc:318
Definition: agent.h:43
A utility wrapper around a generator and a distribution.