aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Framework/Communications/Limit/TimeLimitStrategy.cs
blob: 7ac8293b77dc90a2aa9e93f1d06f4e4b4ec0a0cd (plain)
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
/*
 * Copyright (c) Contributors, http://opensimulator.org/
 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of the OpenSimulator Project 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 DEVELOPERS ``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 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.
 */

using System;
using System.Collections.Generic;

namespace OpenSim.Framework.Communications.Limit
{
    /// <summary>
    /// Limit requests by discarding repeat attempts that occur within a given time period
    ///
    /// XXX Don't use this for limiting texture downloading, at least not until we better handle multiple requests
    /// for the same texture at different resolutions.
    /// </summary>
    public class TimeLimitStrategy<TId> : IRequestLimitStrategy<TId>
    {
        /// <summary>
        /// Record the time at which an asset request occurs.
        /// </summary>
        private readonly Dictionary<TId, Request> requests = new Dictionary<TId, Request>();

        /// <summary>
        /// The minimum time period between which requests for the same data will be serviced.
        /// </summary>
        private readonly TimeSpan m_repeatPeriod;
        public TimeSpan RepeatPeriod
        {
            get { return m_repeatPeriod; }
        }

        /// <summary></summary>
        /// <param name="repeatPeriod"></param>
        public TimeLimitStrategy(TimeSpan repeatPeriod)
        {
            m_repeatPeriod = repeatPeriod;
        }

        /// <summary>
        /// <see cref="IRequestLimitStrategy"/>
        /// </summary>
        public bool AllowRequest(TId id)
        {
            if (IsMonitoringRequests(id))
            {
                DateTime now = DateTime.Now;
                TimeSpan elapsed = now - requests[id].Time;

                if (elapsed < RepeatPeriod)
                {
                    requests[id].Refusals += 1;
                    return false;
                }

                requests[id].Time = now;
            }

            return true;
        }

        /// <summary>
        /// <see cref="IRequestLimitStrategy"/>
        /// </summary>
        public bool IsFirstRefusal(TId id)
        {
            if (IsMonitoringRequests(id))
            {
                if (1 == requests[id].Refusals)
                {
                    return true;
                }
            }

            return false;
        }

        /// <summary>
        /// <see cref="IRequestLimitStrategy"/>
        /// </summary>
        public void MonitorRequests(TId id)
        {
            if (!IsMonitoringRequests(id))
            {
                requests.Add(id, new Request(DateTime.Now));
            }
        }

        /// <summary>
        /// <see cref="IRequestLimitStrategy"/>
        /// </summary>
        public bool IsMonitoringRequests(TId id)
        {
            return requests.ContainsKey(id);
        }
    }

    /// <summary>
    /// Private request details.
    /// </summary>
    class Request
    {
        /// <summary>
        /// Time of last request
        /// </summary>
        public DateTime Time;

        /// <summary>
        /// Number of refusals associated with this request
        /// </summary>
        public int Refusals;

        public Request(DateTime time)
        {
            Time = time;
        }
    }
}