EMANE  1.2.1
nemstatefullayer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-2014 - 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 EMANENEMSTATEFULLAYER_HEADER_
35 #define EMANENEMSTATEFULLAYER_HEADER_
36 
37 #include "emane/nemlayer.h"
39 
40 #include <memory>
41 
42 namespace EMANE
43 {
44  class NEMLayerState;
45 
54  class NEMStatefulLayer : public NEMLayer
55  {
56  public:
67  NEMLayer * pLayer,
68  PlatformServiceProvider *pPlatformService);
69 
76  void initialize(Registrar & registrar) override;
77 
78  void configure(const ConfigurationUpdate & update) override;
79 
80  void start() override;
81 
82  void postStart() override;
83 
84  void stop() override;
85 
86  void destroy() throw() override;
87 
88  void processConfiguration(const ConfigurationUpdate & update) override;
89 
90  void processUpstreamControl(const ControlMessages & msgs) override;
91 
93  const ControlMessages & msgs) override;
94 
95  void processDownstreamControl(const ControlMessages & msgs) override;
96 
97 
99  const ControlMessages & msgs) override;
100 
101 
102  void processEvent(const EventId & eventId,
103  const Serialization & serialization) override;
104 
105  void processTimedEvent(TimerEventId eventId,
106  const TimePoint & expireTime,
107  const TimePoint & scheduleTime,
108  const TimePoint & fireTime,
109  const void * arg) override;
110 
111  void setUpstreamTransport(UpstreamTransport * pUpstreamTransport) override;
112 
113 
114  void setDownstreamTransport(DownstreamTransport * pDownstreamTransport) override;
115 
116 
122  void changeState(NEMLayerState * pState);
123 
124  private:
125  std::unique_ptr<NEMLayer> pLayer_;
126  NEMLayerState * pState_;
127  };
128 }
129 
130 #endif // EMANENEMSTATEFULLAYER_HEADER_
std::string Serialization
Definition: serializable.h:42
NEMStatefulLayer(NEMId id, NEMLayer *pLayer, PlatformServiceProvider *pPlatformService)
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 setDownstreamTransport(DownstreamTransport *pDownstreamTransport) override
std::list< const ControlMessage * > ControlMessages
void changeState(NEMLayerState *pState)
Base class for NEMLayer containers. Builders construct NEMLayer objects to contain derived instances ...
Definition: nemlayer.h:57
void processConfiguration(const ConfigurationUpdate &update) override
std::uint16_t EventId
Definition: types.h:53
void setUpstreamTransport(UpstreamTransport *pUpstreamTransport) override
The PlatformServiceProvider interface provides access to emulator services.
void configure(const ConfigurationUpdate &update) override
void processUpstreamControl(const ControlMessages &msgs) override
void processDownstreamControl(const ControlMessages &msgs) override
Specialized packet the allows downstream processing to add layer specific headers as the packet trave...
void initialize(Registrar &registrar) override
initialize
void processUpstreamPacket(UpstreamPacket &pkt, const ControlMessages &msgs) override
void processDownstreamPacket(DownstreamPacket &pkt, const ControlMessages &msgs) override
std::uint16_t NEMId
Definition: types.h:52
Encapsulated behavior associated with an NEMLayer depending on the layer&#39;s current context...
Definition: nemlayerstate.h:50
std::vector< ConfigurationNameAnyValues > ConfigurationUpdate
UpstreamTransport allows for processing upstream data and control messages. Upstream packets and cont...
std::size_t TimerEventId
Definition: types.h:54
A layer stack that enforces component state transition rules. The stateful layer is not a fully funct...
Clock::time_point TimePoint
Definition: types.h:50
DownstreamTransport allows for processing downstream data and control messages.
void processTimedEvent(TimerEventId eventId, const TimePoint &expireTime, const TimePoint &scheduleTime, const TimePoint &fireTime, const void *arg) override
Definition: agent.h:43
void processEvent(const EventId &eventId, const Serialization &serialization) override