EMANE  1.2.1
models/mac/bypass/maclayer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013 - Adjacent Link LLC, Bridgewater, New Jersey
3  * Copyright (c) 2008 - 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 EMANEMODELSBYPASSMACLAYER_HEADER_
35 #define EMANEMODELSBYPASSMACLAYER_HEADER_
36 
37 #include "emane/maclayerimpl.h"
38 #include "emane/mactypes.h"
40 
41 namespace EMANE
42 {
43  namespace Models
44  {
45  namespace Bypass
46  {
53  {
54  public:
60  MACLayer(NEMId id,
61  PlatformServiceProvider * pPlatformService,
62  RadioServiceProvider * pRadioServiceProvider);
63 
69  ~MACLayer();
70 
71  void initialize(EMANE::Registrar & registrar) override;
72 
73  void configure(const EMANE::ConfigurationUpdate & update) override;
74 
75  void start() override;
76 
77  void stop() override;
78 
79  void destroy() throw() override;
80 
82 
85  const EMANE::ControlMessages & msgs);
86 
88 
89 
91  const EMANE::ControlMessages & msgs);
92 
93  void processEvent(const EMANE::EventId & id,
94  const EMANE::Serialization & serialization);
95 
97  const EMANE::TimePoint & timePoint,
98  const void * arg);
99 
100  private:
102 
103  std::uint16_t u16SequenceNumber_;
104 
105  Utils::CommonLayerStatistics commonLayerStatistics_;
106  };
107  }
108  }
109 }
110 
111 #endif // EMANEMODELSBYPASSMACLAYER_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
void initialize(EMANE::Registrar &registrar) override
std::list< const ControlMessage * > ControlMessages
Implementation of the bypass MAC layer.
Common NEM layer statistics and drop reason tables.
std::uint16_t EventId
Definition: types.h:53
The PlatformServiceProvider interface provides access to emulator services.
void processTimedEvent(EMANE::TimerEventId eventId, const EMANE::TimePoint &timePoint, const void *arg)
void processUpstreamPacket(const EMANE::CommonMACHeader &hdr, EMANE::UpstreamPacket &pkt, const EMANE::ControlMessages &msgs)
MACLayer(NEMId id, PlatformServiceProvider *pPlatformService, RadioServiceProvider *pRadioServiceProvider)
constructor
Specialized packet the allows downstream processing to add layer specific headers as the packet trave...
std::uint16_t RegistrationId
Definition: types.h:59
std::uint16_t NEMId
Definition: types.h:52
void processDownstreamControl(const EMANE::ControlMessages &msgs)
The RadioServiceProvider interface provides access to radio (RF) model specific services.
void configure(const EMANE::ConfigurationUpdate &update) override
void processDownstreamPacket(EMANE::DownstreamPacket &pkt, const EMANE::ControlMessages &msgs)
std::vector< ConfigurationNameAnyValues > ConfigurationUpdate
void processEvent(const EMANE::EventId &id, const EMANE::Serialization &serialization)
const RegistrationId REGISTERED_EMANE_MAC_BYPASS
Definition: mactypes.h:50
std::size_t TimerEventId
Definition: types.h:54
Clock::time_point TimePoint
Definition: types.h:50
Definition: agent.h:43
void processUpstreamControl(const EMANE::ControlMessages &msgs)
Interface used to create a MAC layer plugin implementation.
Definition: maclayerimpl.h:48