EMANE  1.2.1
transport.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014 - Adjacent Link LLC, Bridgewater, New Jersey
3  * Copyright (c) 2008-2011 - 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 EMANETRANSPORT_HEADER_
35 #define EMANETRANSPORT_HEADER_
36 
37 #include "emane/nemlayer.h"
38 
39 #include <string>
40 #include <list>
41 
42 namespace EMANE
43 {
49  class Transport : public NEMLayer
50  {
51  public:
55  virtual ~Transport(){}
56 
62  NEMId getNEMId() const { return id_; }
63 
64  protected:
65  Transport(NEMId id, PlatformServiceProvider * pPlatformService):
66  NEMLayer(id, pPlatformService)
67  {}
68 
69 private:
70  // method meaningless for a Transport layer
71  void processDownstreamPacket(DownstreamPacket &,
72  const ControlMessages &){};
73 
74  void processDownstreamControl(const ControlMessages &){};
75 
76  void setUpstreamTransport(UpstreamTransport *){};
77 
78  void sendUpstreamPacket(UpstreamPacket &,
79  const ControlMessages &){};
80  };
81 }
82 
83 
84 #define DECLARE_TRANSPORT(X) \
85  extern "C" EMANE::Transport * create(EMANE::NEMId id, EMANE::PlatformServiceProvider *p) \
86  {return new X(id,p);} \
87  extern "C" void destroy(EMANE::Transport * p) \
88  {delete p;}
89 #endif //EMANETRANSPORT_HEADER_
90 
A Packet class that allows upstream processing to strip layer headers as the packet travels up the st...
Base class for all transports.
Definition: transport.h:49
std::list< const ControlMessage * > ControlMessages
Base class for NEMLayer containers. Builders construct NEMLayer objects to contain derived instances ...
Definition: nemlayer.h:57
Transport(NEMId id, PlatformServiceProvider *pPlatformService)
Definition: transport.h:65
The PlatformServiceProvider interface provides access to emulator services.
Specialized packet the allows downstream processing to add layer specific headers as the packet trave...
std::uint16_t NEMId
Definition: types.h:52
virtual ~Transport()
Definition: transport.h:55
UpstreamTransport allows for processing upstream data and control messages. Upstream packets and cont...
Definition: agent.h:43
NEMId getNEMId() const
Definition: transport.h:62