IRequestLimitStrategy.cs 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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 OpenSimulator 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. namespace OpenSim.Framework.Communications.Limit
  28. {
  29. /// <summary>
  30. /// Interface for strategies that can limit requests from the client. Currently only used in the
  31. /// texture modules to deal with repeated requests for certain textures. However, limiting strategies
  32. /// could be used with other requests.
  33. /// </summary>
  34. public interface IRequestLimitStrategy<TId>
  35. {
  36. /// <summary>
  37. /// Should the request be allowed? If the id is not monitored, then the request is always allowed.
  38. /// Otherwise, the strategy criteria will be applied.
  39. /// </summary>
  40. /// <param name="id"></param>
  41. /// <returns></returns>
  42. bool AllowRequest(TId id);
  43. /// <summary>
  44. /// Has the request been refused just once?
  45. /// </summary>
  46. /// <returns>False if the request has not yet been refused, or if the request has been refused more
  47. /// than once.</returns>
  48. bool IsFirstRefusal(TId id);
  49. /// <summary>
  50. /// Start monitoring for future AllowRequest calls. If the id is already monitored, then monitoring
  51. /// continues.
  52. /// </summary>
  53. /// <param name="id"></param>
  54. void MonitorRequests(TId id);
  55. /// <summary>
  56. /// Is the id being monitored?
  57. /// </summary>
  58. /// <param name="uuid"> </param>
  59. /// <returns></returns>
  60. bool IsMonitoringRequests(TId id);
  61. }
  62. }