EMANE  1.0.1
nemlayerstaterunning.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-2014 - Adjacent Link LLC, Bridgewater, New Jersey
3  * Copyright (c) 2008-2012 - 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 EMANENEMLAYERSTATERUNNING_HEADER_
35 #define EMANENEMLAYERSTATERUNNING_HEADER_
36 
37 #include "nemlayerstate.h"
38 
39 #include "emane/utils/singleton.h"
40 
41 namespace EMANE
42 {
51  public Utils::Singleton<NEMLayerStateRunning>
52  {
53  public:
55 
64  void handlePostStart(NEMStatefulLayer * pStatefulLayer, NEMLayer * pLayer);
65 
77  void handleStop(NEMStatefulLayer * pStatefulLayer, NEMLayer * pLayer);
78 
79 
88  virtual void processConfiguration(NEMStatefulLayer * pStatefulLayer,
89  NEMLayer * pLayer,
90  const ConfigurationUpdate & update);
91 
101  void processDownstreamControl(NEMStatefulLayer * pStatefulLayer,
102  NEMLayer * pLayer,
103  const ControlMessages & msgs);
104 
115  void processDownstreamPacket(NEMStatefulLayer * pStatefulLayer,
116  NEMLayer * pLayer,
117  DownstreamPacket & pkt,
118  const ControlMessages & msgs);
119 
130  void processUpstreamPacket(NEMStatefulLayer * pStatefulLayer,
131  NEMLayer * pLayer,
132  UpstreamPacket & pkt,
133  const ControlMessages & msgs);
134 
144  void processUpstreamControl(NEMStatefulLayer * pStatefulLayer,
145  NEMLayer * pLayer,
146  const ControlMessages & msgs);
147 
158  void processEvent(NEMStatefulLayer * pStatefulLayer,
159  NEMLayer * pLayer,
160  const EventId & id,
161  const Serialization & serialization);
162 
176  void processTimedEvent(NEMStatefulLayer * pStatefulLayer,
177  NEMLayer * pLayer,
178  TimerEventId eventId,
179  const TimePoint & expireTime,
180  const TimePoint & scheduleTime,
181  const TimePoint & fireTime,
182  const void * arg);
183 
184  protected:
186  };
187 
189 }
190 
191 #endif //EMANENEMLAYERSTATERUNNING_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 processDownstreamPacket(NEMStatefulLayer *pStatefulLayer, NEMLayer *pLayer, DownstreamPacket &pkt, const ControlMessages &msgs)
virtual void processConfiguration(NEMStatefulLayer *pStatefulLayer, NEMLayer *pLayer, const ConfigurationUpdate &update)
void processEvent(NEMStatefulLayer *pStatefulLayer, NEMLayer *pLayer, const EventId &id, const Serialization &serialization)
Ensure a class only has one instance, and provide a global point of access to it. ...
Definition: singleton.h:47
std::list< const ControlMessage * > ControlMessages
void handlePostStart(NEMStatefulLayer *pStatefulLayer, NEMLayer *pLayer)
Base class for NEMLayer containers. Builders construct NEMLayer objects to contain derived instances ...
Definition: nemlayer.h:57
void processUpstreamControl(NEMStatefulLayer *pStatefulLayer, NEMLayer *pLayer, const ControlMessages &msgs)
std::uint16_t EventId
Definition: types.h:53
void handleStop(NEMStatefulLayer *pStatefulLayer, NEMLayer *pLayer)
Component start complete all transport processing and event actions are now allowed. Allowable transitions are Component::stop().
Specialized packet the allows downstream processing to add layer specific headers as the packet trave...
void processUpstreamPacket(NEMStatefulLayer *pStatefulLayer, NEMLayer *pLayer, UpstreamPacket &pkt, const ControlMessages &msgs)
void processTimedEvent(NEMStatefulLayer *pStatefulLayer, NEMLayer *pLayer, TimerEventId eventId, const TimePoint &expireTime, const TimePoint &scheduleTime, const TimePoint &fireTime, const void *arg)
Encapsulated behavior associated with an NEMLayer depending on the layer&#39;s current context...
Definition: nemlayerstate.h:50
std::vector< ConfigurationNameAnyValues > ConfigurationUpdate
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
Definition: agent.h:43
void processDownstreamControl(NEMStatefulLayer *pStatefulLayer, NEMLayer *pLayer, const ControlMessages &msgs)