1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-
// Copyright (c) 2001-2011 XORP, Inc and Others
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, Version 2, June
// 1991 as published by the Free Software Foundation. Redistribution
// and/or modification of this program under the terms of any other
// version of the GNU General Public License is not permitted.
//
// 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. For more details,
// see the GNU General Public License, Version 2, a copy of which can be
// found in the XORP LICENSE.gpl file.
//
// XORP Inc, 2953 Bunker Hill Lane, Suite 204, Santa Clara, CA 95054, USA;
// http://xorp.net
// $XORP: xorp/rip/packet_queue.hh,v 1.13 2008/10/02 21:58:16 bms Exp $
#ifndef __RIP_PACKET_QUEUE_HH__
#define __RIP_PACKET_QUEUE_HH__
#include "libxorp/xorp.h"
#include "packets.hh"
/**
* @short Outbound packet queue.
*
* The queue is of fixed size and does FIFO. When the queue becomes
* full the eldest packet behind the head is dropped, ie since the
* head may be in transit.
*/
template <typename A>
class PacketQueue
{
public:
typedef list<const RipPacket<A>*> QueueRep;
public:
PacketQueue();
~PacketQueue();
/**
* Place packet in ready to sent queue. The supplied packet is
* expected to have been allocated with the standard new operator
* and will be destructed by the packet queue when it is dropped
* or popped from the queue.
*
* This may cause older packets in the queue to be dropped to make
* sufficient space for new packet.
*/
void enqueue_packet(const RipPacket<A>* pkt);
/**
* @return true if no packets are queued, false otherwise.
*/
bool empty() const;
/**
* Peek at head packet if it exists.
*
* @return pointer to head packet if it exists, 0 otherwise.
*/
const RipPacket<A>* head() const;
/**
* Remove head packet.
*/
void pop_head();
/**
* Discard packet behind head packet to make space for new packets.
*
* @return true if an old packet was dropped, false if no packets
* dropped.
*/
bool drop_old();
/**
* Flush queued packets.
*/
void flush_packets();
/**
* Set the maximum amount of data to buffer.
*/
void set_max_buffered_bytes(uint32_t mb);
/**
* Get the maximum amount of buffered data.
*/
uint32_t max_buffered_bytes() const;
/**
* Get the current amount of buffered data.
*/
uint32_t buffered_bytes() const;
/**
* Get the number of packets dropped from queue.
*/
uint32_t drop_count() const;
/**
* Reset packet drop counter.
*/
void reset_drop_count();
protected:
QueueRep _ready_packets;
uint32_t _buffered_bytes;
uint32_t _max_buffered_bytes;
uint32_t _drops;
};
#endif // __RIP_PACKET_QUEUE_HH__
|
