sources/network/packetqueue.h

branch
protocol5
changeset 167
0150f86e68f0
equal deleted inserted replaced
166:af5fa8c43ca8 167:0150f86e68f0
1 /*
2 Copyright 2016 Teemu Piippo
3 All rights reserved.
4
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
7 are met:
8
9 1. Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 2. Redistributions in binary form must reproduce the above copyright
12 notice, this list of conditions and the following disclaimer in the
13 documentation and/or other materials provided with the distribution.
14 3. Neither the name of the copyright holder nor the names of its
15 contributors may be used to endorse or promote products derived from
16 this software without specific prior written permission.
17
18 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
21 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER
22 OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
25 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
26 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
27 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31 #pragma once
32 #include <map>
33 #include <set>
34 #include "../main.h"
35 #include "../list.h"
36 BEGIN_ZFC_NAMESPACE
37
38 /*!
39 * \brief The PacketQueue class stores packets awaiting processing.
40 *
41 * The UDP protocol makes no guarantees of packet delivery. Packets may wind up being dropped, or delivered in the wrong
42 * order. This class mitigates that issue by storing the packets into a queue, and popping packets in order.
43 */
44 class PacketQueue
45 {
46 public:
47 PacketQueue();
48
49 bool addPacket(unsigned int sequenceNumber, const ByteArray &data);
50 std::set<unsigned int> getWaitingPackets() const;
51 std::set<int> getLostPackets() const;
52 int getNextSequenceNumber() const;
53 bool hasPacketsToPop() const;
54 bool isStuck() const;
55 bool popNextPacket(ByteArray& packet);
56
57 private:
58 std::map<unsigned int, ByteArray> m_queue;
59 unsigned int m_currentSequenceNumber;
60 };
61
62 END_ZFC_NAMESPACE

mercurial