sources/network/packetqueue.h

/*
	Copyright 2016 Teemu Piippo
	All rights reserved.

	Redistribution and use in source and binary forms, with or without
	modification, are permitted provided that the following conditions
	are met:

	1. Redistributions of source code must retain the above copyright
	   notice, this list of conditions and the following disclaimer.
	2. Redistributions in binary form must reproduce the above copyright
	   notice, this list of conditions and the following disclaimer in the
	   documentation and/or other materials provided with the distribution.
	3. Neither the name of the copyright holder nor the names of its
	   contributors may be used to endorse or promote products derived from
	   this software without specific prior written permission.

	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
	TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
	PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER
	OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
	EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
	PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
	PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
	LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
	NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
	SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#pragma once
#include <map>
#include <set>
#include "../main.h"
#include "../list.h"
BEGIN_ZFC_NAMESPACE

/*!
 * \brief The PacketQueue class stores packets awaiting processing.
 *
 * The UDP protocol makes no guarantees of packet delivery. Packets may wind up being dropped, or delivered in the wrong
 * order. This class mitigates that issue by storing the packets into a queue, and popping packets in order.
 */
class PacketQueue
{
public:
	PacketQueue();

	bool addPacket(unsigned int sequenceNumber, const ByteArray &data);
	std::set<unsigned int> getWaitingPackets() const;
	std::set<int> getLostPackets() const;
	int getNextSequenceNumber() const;
	bool hasPacketsToPop() const;
	bool isStuck() const;
	bool popNextPacket(ByteArray& packet);

private:
	std::map<unsigned int, ByteArray> m_queue;
	unsigned int m_currentSequenceNumber;
};

END_ZFC_NAMESPACE