EMANE  1.2.1
upstreampacket.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-2014,2018 - Adjacent Link LLC, Bridgewater,
3  * New Jersey
4  * Copyright (c) 2008 - DRS CenGen, LLC, Columbia, Maryland
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  * * Neither the name of DRS CenGen, LLC nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef EMANEUPSTREAMPACKET_HEADER_
36 #define EMANEUPSTREAMPACKET_HEADER_
37 
38 #include "emane/packetinfo.h"
39 #include "emane/utils/vectorio.h"
40 
41 #include <memory>
42 
43 namespace EMANE
44 {
53  {
54  public:
62  UpstreamPacket(const PacketInfo & info,const void * buf,size_t len);
63 
73  UpstreamPacket(const PacketInfo & info,const Utils::VectorIO & vectorIO);
74 
79 
84 
85 
90 
95 
96 
100  ~UpstreamPacket();
101 
110  size_t strip(size_t size);
111 
112 
119  std::uint16_t stripLengthPrefixFraming();
120 
127  std::uint32_t stripLengthPrefixFramingLong();
128 
136  const void * get() const;
137 
143  size_t length() const;
144 
150  const PacketInfo & getPacketInfo() const;
151 
152  private:
153  class Implementation;
154  std::unique_ptr<Implementation> pImpl_;
155  };
156 }
157 
158 #endif // EMANEDOWNSTREAMPACKET_HEADER_
A Packet class that allows upstream processing to strip layer headers as the packet travels up the st...
UpstreamPacket(const PacketInfo &info, const void *buf, size_t len)
std::uint32_t stripLengthPrefixFramingLong()
std::uint16_t stripLengthPrefixFraming()
size_t strip(size_t size)
std::vector< iovec > VectorIO
Definition: vectorio.h:43
Store source, destination, creation time and priority information for a packet.
Definition: packetinfo.h:50
const PacketInfo & getPacketInfo() const
UpstreamPacket & operator=(const UpstreamPacket &pkt)
Definition: agent.h:43