EMANE  1.2.1
downstreamtransport.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-2014 - Adjacent Link LLC, Bridgewater, New Jersey
3  * Copyright (c) 2008-2009 - 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 EMANEDOWNSTREAMTRANSPORT_HEADER_
35 #define EMANEDOWNSTREAMTRANSPORT_HEADER_
36 
37 #include "emane/controlmessage.h"
38 #include "emane/downstreampacket.h"
39 #include "emane/upstreampacket.h"
40 
41 namespace EMANE
42 {
43  class UpstreamTransport;
44 
52  {
53  public:
55 
62  virtual void processDownstreamPacket(DownstreamPacket & pkt,
63  const ControlMessages & msgs = empty) = 0;
64 
71  virtual void processDownstreamControl(const ControlMessages & msgs) = 0;
72 
79  void virtual setUpstreamTransport(UpstreamTransport * pUpstreamTransport)
80  {
81  pUpstreamTransport_ = pUpstreamTransport;
82  }
83 
91  const ControlMessages & msgs = empty);
92 
99  void sendUpstreamControl(const ControlMessages & msgs);
100 
101 
102  static const ControlMessages empty;
103 
104  protected:
105 
107  pUpstreamTransport_(0){}
108 
109  private:
110  UpstreamTransport * pUpstreamTransport_;
111  };
112 }
113 
115 
116 #endif //EMANEDOWNSTREAMTRANSPORT_HEADER_
virtual void processDownstreamControl(const ControlMessages &msgs)=0
A Packet class that allows upstream processing to strip layer headers as the packet travels up the st...
virtual void processDownstreamPacket(DownstreamPacket &pkt, const ControlMessages &msgs=empty)=0
std::list< const ControlMessage * > ControlMessages
Specialized packet the allows downstream processing to add layer specific headers as the packet trave...
static const ControlMessages empty
virtual void setUpstreamTransport(UpstreamTransport *pUpstreamTransport)
void sendUpstreamControl(const ControlMessages &msgs)
UpstreamTransport allows for processing upstream data and control messages. Upstream packets and cont...
void sendUpstreamPacket(UpstreamPacket &pkt, const ControlMessages &msgs=empty)
DownstreamTransport allows for processing downstream data and control messages.
Definition: agent.h:43