/websocket-sharp/Net/HttpListenerPrefixCollection.cs
https://gitlab.com/OriumVR/websocket-sharp · C# · 278 lines · 97 code · 29 blank · 152 comment · 9 complexity · ed7d954b7dacb786f7f939d3ef9264e1 MD5 · raw file
- #region License
- /*
- * HttpListenerPrefixCollection.cs
- *
- * This code is derived from HttpListenerPrefixCollection.cs (System.Net) of Mono
- * (http://www.mono-project.com).
- *
- * The MIT License
- *
- * Copyright (c) 2005 Novell, Inc. (http://www.novell.com)
- * Copyright (c) 2012-2015 sta.blockhead
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- */
- #endregion
- #region Authors
- /*
- * Authors:
- * - Gonzalo Paniagua Javier <gonzalo@novell.com>
- */
- #endregion
- using System;
- using System.Collections;
- using System.Collections.Generic;
- namespace WebSocketSharp.Net
- {
- /// <summary>
- /// Provides the collection used to store the URI prefixes for the <see cref="HttpListener"/>.
- /// </summary>
- /// <remarks>
- /// The <see cref="HttpListener"/> responds to the request which has a requested URI that
- /// the prefixes most closely match.
- /// </remarks>
- public class HttpListenerPrefixCollection : ICollection<string>, IEnumerable<string>, IEnumerable
- {
- #region Private Fields
- private HttpListener _listener;
- private List<string> _prefixes;
- #endregion
- #region Internal Constructors
- internal HttpListenerPrefixCollection (HttpListener listener)
- {
- _listener = listener;
- _prefixes = new List<string> ();
- }
- #endregion
- #region Public Properties
- /// <summary>
- /// Gets the number of prefixes in the collection.
- /// </summary>
- /// <value>
- /// An <see cref="int"/> that represents the number of prefixes.
- /// </value>
- public int Count {
- get {
- return _prefixes.Count;
- }
- }
- /// <summary>
- /// Gets a value indicating whether the access to the collection is read-only.
- /// </summary>
- /// <value>
- /// Always returns <c>false</c>.
- /// </value>
- public bool IsReadOnly {
- get {
- return false;
- }
- }
- /// <summary>
- /// Gets a value indicating whether the access to the collection is synchronized.
- /// </summary>
- /// <value>
- /// Always returns <c>false</c>.
- /// </value>
- public bool IsSynchronized {
- get {
- return false;
- }
- }
- #endregion
- #region Public Methods
- /// <summary>
- /// Adds the specified <paramref name="uriPrefix"/> to the collection.
- /// </summary>
- /// <param name="uriPrefix">
- /// A <see cref="string"/> that represents the URI prefix to add. The prefix must be
- /// a well-formed URI prefix with http or https scheme, and must end with a <c>'/'</c>.
- /// </param>
- /// <exception cref="ArgumentNullException">
- /// <paramref name="uriPrefix"/> is <see langword="null"/>.
- /// </exception>
- /// <exception cref="ArgumentException">
- /// <paramref name="uriPrefix"/> is invalid.
- /// </exception>
- /// <exception cref="ObjectDisposedException">
- /// The <see cref="HttpListener"/> associated with this collection is closed.
- /// </exception>
- public void Add (string uriPrefix)
- {
- _listener.CheckDisposed ();
- HttpListenerPrefix.CheckPrefix (uriPrefix);
- if (_prefixes.Contains (uriPrefix))
- return;
- _prefixes.Add (uriPrefix);
- if (_listener.IsListening)
- EndPointManager.AddPrefix (uriPrefix, _listener);
- }
- /// <summary>
- /// Removes all URI prefixes from the collection.
- /// </summary>
- /// <exception cref="ObjectDisposedException">
- /// The <see cref="HttpListener"/> associated with this collection is closed.
- /// </exception>
- public void Clear ()
- {
- _listener.CheckDisposed ();
- _prefixes.Clear ();
- if (_listener.IsListening)
- EndPointManager.RemoveListener (_listener);
- }
- /// <summary>
- /// Returns a value indicating whether the collection contains the specified
- /// <paramref name="uriPrefix"/>.
- /// </summary>
- /// <returns>
- /// <c>true</c> if the collection contains <paramref name="uriPrefix"/>;
- /// otherwise, <c>false</c>.
- /// </returns>
- /// <param name="uriPrefix">
- /// A <see cref="string"/> that represents the URI prefix to test.
- /// </param>
- /// <exception cref="ArgumentNullException">
- /// <paramref name="uriPrefix"/> is <see langword="null"/>.
- /// </exception>
- /// <exception cref="ObjectDisposedException">
- /// The <see cref="HttpListener"/> associated with this collection is closed.
- /// </exception>
- public bool Contains (string uriPrefix)
- {
- _listener.CheckDisposed ();
- if (uriPrefix == null)
- throw new ArgumentNullException ("uriPrefix");
- return _prefixes.Contains (uriPrefix);
- }
- /// <summary>
- /// Copies the contents of the collection to the specified <see cref="Array"/>.
- /// </summary>
- /// <param name="array">
- /// An <see cref="Array"/> that receives the URI prefix strings in the collection.
- /// </param>
- /// <param name="offset">
- /// An <see cref="int"/> that represents the zero-based index in <paramref name="array"/>
- /// at which copying begins.
- /// </param>
- /// <exception cref="ObjectDisposedException">
- /// The <see cref="HttpListener"/> associated with this collection is closed.
- /// </exception>
- public void CopyTo (Array array, int offset)
- {
- _listener.CheckDisposed ();
- ((ICollection) _prefixes).CopyTo (array, offset);
- }
- /// <summary>
- /// Copies the contents of the collection to the specified array of <see cref="string"/>.
- /// </summary>
- /// <param name="array">
- /// An array of <see cref="string"/> that receives the URI prefix strings in the collection.
- /// </param>
- /// <param name="offset">
- /// An <see cref="int"/> that represents the zero-based index in <paramref name="array"/>
- /// at which copying begins.
- /// </param>
- /// <exception cref="ObjectDisposedException">
- /// The <see cref="HttpListener"/> associated with this collection is closed.
- /// </exception>
- public void CopyTo (string[] array, int offset)
- {
- _listener.CheckDisposed ();
- _prefixes.CopyTo (array, offset);
- }
- /// <summary>
- /// Gets the enumerator used to iterate through the <see cref="HttpListenerPrefixCollection"/>.
- /// </summary>
- /// <returns>
- /// An <see cref="T:System.Collections.Generic.IEnumerator{string}"/> instance used to iterate
- /// through the collection.
- /// </returns>
- public IEnumerator<string> GetEnumerator ()
- {
- return _prefixes.GetEnumerator ();
- }
- /// <summary>
- /// Removes the specified <paramref name="uriPrefix"/> from the collection.
- /// </summary>
- /// <returns>
- /// <c>true</c> if <paramref name="uriPrefix"/> is successfully found and removed;
- /// otherwise, <c>false</c>.
- /// </returns>
- /// <param name="uriPrefix">
- /// A <see cref="string"/> that represents the URI prefix to remove.
- /// </param>
- /// <exception cref="ArgumentNullException">
- /// <paramref name="uriPrefix"/> is <see langword="null"/>.
- /// </exception>
- /// <exception cref="ObjectDisposedException">
- /// The <see cref="HttpListener"/> associated with this collection is closed.
- /// </exception>
- public bool Remove (string uriPrefix)
- {
- _listener.CheckDisposed ();
- if (uriPrefix == null)
- throw new ArgumentNullException ("uriPrefix");
- var ret = _prefixes.Remove (uriPrefix);
- if (ret && _listener.IsListening)
- EndPointManager.RemovePrefix (uriPrefix, _listener);
- return ret;
- }
- #endregion
- #region Explicit Interface Implementations
- /// <summary>
- /// Gets the enumerator used to iterate through the <see cref="HttpListenerPrefixCollection"/>.
- /// </summary>
- /// <returns>
- /// An <see cref="IEnumerator"/> instance used to iterate through the collection.
- /// </returns>
- IEnumerator IEnumerable.GetEnumerator ()
- {
- return _prefixes.GetEnumerator ();
- }
- #endregion
- }
- }