0
0
mirror of https://github.com/OpenVPN/openvpn3.git synced 2024-09-20 20:13:05 +02:00
openvpn3/openvpn/reliable/relrecv.hpp
Samuli Seppänen 04b2a3c9b7 Switch from AGPLv3 to GPLv3
Signed-off-by: Samuli Seppänen <samuli@openvpn.net>
2017-03-16 14:43:55 +02:00

98 lines
2.8 KiB
C++

// OpenVPN -- An application to securely tunnel IP networks
// over a single port, with support for SSL/TLS-based
// session authentication and key exchange,
// packet encryption, packet authentication, and
// packet compression.
//
// Copyright (C) 2012-2016 OpenVPN Technologies, Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License Version 3
// as published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program in the COPYING file.
// If not, see <http://www.gnu.org/licenses/>.
// Receiver side of reliability layer
#ifndef OPENVPN_RELIABLE_RELRECV_H
#define OPENVPN_RELIABLE_RELRECV_H
#include <openvpn/common/size.hpp>
#include <openvpn/common/exception.hpp>
#include <openvpn/common/msgwin.hpp>
#include <openvpn/reliable/relcommon.hpp>
namespace openvpn {
template <typename PACKET>
class ReliableRecvTemplate
{
public:
OPENVPN_SIMPLE_EXCEPTION(rel_next_sequenced_not_ready);
typedef reliable::id_t id_t;
class Message : public ReliableMessageBase<PACKET>
{
friend class ReliableRecvTemplate;
};
ReliableRecvTemplate() {}
ReliableRecvTemplate(const id_t span) { init(span); }
void init(const id_t span)
{
window_.init(0, span);
}
// Call with unsequenced packet off of the wire.
// Will return receive flags below.
enum {
ACK_TO_SENDER = (1<<0), // ACK for this packet should be returned to sender
IN_WINDOW = (1<<1) // Packet is in-window (otherwise, packet is dropped)
};
unsigned int receive(const PACKET& packet, const id_t id)
{
if (window_.in_window(id))
{
Message& m = window_.ref_by_id(id);
m.id_ = id;
m.packet = packet;
return ACK_TO_SENDER|IN_WINDOW;
}
else
return window_.pre_window(id) ? ACK_TO_SENDER : 0;
}
// Return true if next_sequenced() is ready to return next message
bool ready() const { return window_.head_defined(); }
// Return next message in sequence.
// Requires that ready() returns true.
Message& next_sequenced()
{
return window_.ref_head();
}
// Call after message returned by receive is ready to
// be disposed of.
void advance()
{
window_.rm_head_nocheck();
}
private:
MessageWindow<Message, id_t> window_;
};
} // namespace openvpn
#endif // OPENVPN_RELIABLE_RELRECV_H