EMANE  1.2.1
phylayerimpl.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 EMANEPHYLAYERIMPL_HEADER_
35 #define EMANEPHYLAYERIMPL_HEADER_
36 
37 #include "emane/nemlayer.h"
38 #include "emane/commonphyheader.h"
39 
40 namespace EMANE
41 {
54  {
55  public:
57 
69  virtual void processUpstreamPacket(const CommonPHYHeader & hdr,
70  UpstreamPacket & pkt,
71  const ControlMessages & msgs = UpstreamTransport::empty) = 0;
72 
83  void sendDownstreamPacket(const CommonPHYHeader & hdr,
84  DownstreamPacket & pkt,
86 
87  protected:
89  NEMLayer(id, p)
90  {}
91 
92  private:
93  // method meaningless for a PHY layer
94  void processUpstreamControl(const ControlMessages &){}
95 
96  void processUpstreamPacket(UpstreamPacket & pkt, const ControlMessages & msgs);
97 
100 
101  };
102 
103  typedef PHYLayerImplementor * (*createPHYFunc)(NEMId id, PlatformServiceProvider *p);
104  typedef void (*destroyPHYFunc)( PHYLayerImplementor*);
105 }
106 
107 #define DECLARE_PHY_LAYER(X) \
108  extern "C" EMANE::PHYLayerImplementor * create(EMANE::NEMId id, EMANE::PlatformServiceProvider *p) \
109  {return new X(id,p);} \
110  extern "C" void destroy(EMANE::PHYLayerImplementor * p) \
111  {delete p;}
112 
113 #include "emane/phylayerimpl.inl"
114 
115 #endif //EMANEPHYLAYERIMPL_HEADER_
A Packet class that allows upstream processing to strip layer headers as the packet travels up the st...
PHYLayerImplementor(NEMId id, PlatformServiceProvider *p)
Definition: phylayerimpl.h:88
Interface used to create a PHY layer plugin implementation.
Definition: phylayerimpl.h:53
std::list< const ControlMessage * > ControlMessages
Base class for NEMLayer containers. Builders construct NEMLayer objects to contain derived instances ...
Definition: nemlayer.h:57
void sendDownstreamPacket(const CommonPHYHeader &hdr, DownstreamPacket &pkt, const ControlMessages &msgs=DownstreamTransport::empty)
The PlatformServiceProvider interface provides access to emulator services.
The common physical layer header used to facilitate heterogeneous radio model experimentation.
Specialized packet the allows downstream processing to add layer specific headers as the packet trave...
std::uint16_t NEMId
Definition: types.h:52
virtual void processUpstreamPacket(const CommonPHYHeader &hdr, UpstreamPacket &pkt, const ControlMessages &msgs=UpstreamTransport::empty)=0
static const ControlMessages empty
static const ControlMessages empty
void(* destroyPHYFunc)(PHYLayerImplementor *)
Definition: phylayerimpl.h:104
Definition: agent.h:43