diff options
author | Justin Clarke Casey | 2008-03-24 18:21:06 +0000 |
---|---|---|
committer | Justin Clarke Casey | 2008-03-24 18:21:06 +0000 |
commit | 8c0955321a5f0d4de21ceb9b98b4e329e1b56200 (patch) | |
tree | 245c0afe78f579e698e3973d1254bedda19e2fbd /OpenSim/Framework/Communications/Limit/RepeatLimitStrategy.cs | |
parent | Fixed a small XmlRpcCommand bug (diff) | |
download | opensim-SC_OLD-8c0955321a5f0d4de21ceb9b98b4e329e1b56200.zip opensim-SC_OLD-8c0955321a5f0d4de21ceb9b98b4e329e1b56200.tar.gz opensim-SC_OLD-8c0955321a5f0d4de21ceb9b98b4e329e1b56200.tar.bz2 opensim-SC_OLD-8c0955321a5f0d4de21ceb9b98b4e329e1b56200.tar.xz |
* Refactor: Genericise request limit strategies and move to OpenSim.Framework.Communications.Limit
Diffstat (limited to '')
-rw-r--r-- | OpenSim/Framework/Communications/Limit/RepeatLimitStrategy.cs | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/OpenSim/Framework/Communications/Limit/RepeatLimitStrategy.cs b/OpenSim/Framework/Communications/Limit/RepeatLimitStrategy.cs new file mode 100644 index 0000000..6dd0fa1 --- /dev/null +++ b/OpenSim/Framework/Communications/Limit/RepeatLimitStrategy.cs | |||
@@ -0,0 +1,113 @@ | |||
1 | /* | ||
2 | * Copyright (c) Contributors, http://opensimulator.org/ | ||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
4 | * | ||
5 | * Redistribution and use in source and binary forms, with or without | ||
6 | * modification, are permitted provided that the following conditions are met: | ||
7 | * * Redistributions of source code must retain the above copyright | ||
8 | * notice, this list of conditions and the following disclaimer. | ||
9 | * * Redistributions in binary form must reproduce the above copyright | ||
10 | * notice, this list of conditions and the following disclaimer in the | ||
11 | * documentation and/or other materials provided with the distribution. | ||
12 | * * Neither the name of the OpenSim Project nor the | ||
13 | * names of its contributors may be used to endorse or promote products | ||
14 | * derived from this software without specific prior written permission. | ||
15 | * | ||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
26 | */ | ||
27 | |||
28 | using System; | ||
29 | using System.Collections.Generic; | ||
30 | |||
31 | namespace OpenSim.Framework.Communications.Limit | ||
32 | { | ||
33 | /// <summary> | ||
34 | /// Limit requests by discarding them after they've been repeated a certain number of times. | ||
35 | /// </summary> | ||
36 | public class RepeatLimitStrategy<TId> : IRequestLimitStrategy<TId> | ||
37 | { | ||
38 | private static readonly log4net.ILog m_log | ||
39 | = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType); | ||
40 | |||
41 | /// <summary> | ||
42 | /// Record each asset request that we're notified about. | ||
43 | /// </summary> | ||
44 | private readonly Dictionary<TId, int> requestCounts = new Dictionary<TId, int>(); | ||
45 | |||
46 | /// <summary> | ||
47 | /// The maximum number of requests that can be made before we drop subsequent requests. | ||
48 | /// </summary> | ||
49 | private readonly int m_maxRequests; | ||
50 | public int MaxRequests | ||
51 | { | ||
52 | get { return m_maxRequests; } | ||
53 | } | ||
54 | |||
55 | /// <summary></summary> | ||
56 | /// <param name="maxRequests">The maximum number of requests that may be served before all further | ||
57 | /// requests are dropped.</param> | ||
58 | public RepeatLimitStrategy(int maxRequests) | ||
59 | { | ||
60 | m_maxRequests = maxRequests; | ||
61 | } | ||
62 | |||
63 | /// <summary> | ||
64 | /// <see cref="IRequestLimitStrategy"/> | ||
65 | /// </summary> | ||
66 | public bool AllowRequest(TId id) | ||
67 | { | ||
68 | if (requestCounts.ContainsKey(id)) | ||
69 | { | ||
70 | requestCounts[id] += 1; | ||
71 | |||
72 | if (requestCounts[id] > m_maxRequests) | ||
73 | { | ||
74 | return false; | ||
75 | } | ||
76 | } | ||
77 | |||
78 | return true; | ||
79 | } | ||
80 | |||
81 | /// <summary> | ||
82 | /// <see cref="IRequestLimitStrategy"/> | ||
83 | /// </summary> | ||
84 | public bool IsFirstRefusal(TId id) | ||
85 | { | ||
86 | if (m_maxRequests + 1 == requestCounts[id]) | ||
87 | { | ||
88 | return true; | ||
89 | } | ||
90 | |||
91 | return false; | ||
92 | } | ||
93 | |||
94 | /// <summary> | ||
95 | /// <see cref="IRequestLimitStrategy"/> | ||
96 | /// </summary> | ||
97 | public void MonitorRequests(TId id) | ||
98 | { | ||
99 | if (!IsMonitoringRequests(id)) | ||
100 | { | ||
101 | requestCounts.Add(id, 1); | ||
102 | } | ||
103 | } | ||
104 | |||
105 | /// <summary> | ||
106 | /// <see cref="IRequestLimitStrategy"/> | ||
107 | /// </summary> | ||
108 | public bool IsMonitoringRequests(TId id) | ||
109 | { | ||
110 | return requestCounts.ContainsKey(id); | ||
111 | } | ||
112 | } | ||
113 | } | ||