Added some XML documentation comments

websocket-sharp/Net/WebSockets/HttpListenerWebSocketContext.cs

@@ -0,0 +1,271 @@
+#region MIT License
+/*
+ * HttpListenerWebSocketContext.cs
+ *
+ * The MIT License
+ *
+ * Copyright (c) 2012-2013 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
+
+using System;
+using System.Collections.Generic;
+using System.Collections.Specialized;
+using System.Security.Principal;
+
+namespace WebSocketSharp.Net.WebSockets {
+
+  /// <summary>
+  /// Provides access to the WebSocket connection request objects received by the <see cref="HttpListener"/> class.
+  /// </summary>
+  /// <remarks>
+  /// </remarks>
+  public class HttpListenerWebSocketContext : WebSocketContext
+  {
+    #region Fields
+
+    private HttpListenerContext _context;
+    private WebSocket           _socket;
+    private WsStream            _stream;
+
+    #endregion
+
+    #region Constructor
+
+    internal HttpListenerWebSocketContext(HttpListenerContext context)
+    {
+      _context = context;
+      _stream  = WsStream.CreateServerStream(context);
+      _socket  = new WebSocket(this);
+    }
+
+    #endregion
+
+    #region Internal Properties
+
+    internal HttpListenerContext BaseContext {
+      get {
+        return _context;
+      }
+    }
+
+    internal WsStream Stream {
+      get {
+        return _stream;
+      }
+    }
+
+    #endregion
+
+    #region Public Properties
+
+    /// <summary>
+    /// Gets the cookies used in the WebSocket opening handshake.
+    /// </summary>
+    /// <value>
+    /// A <see cref="WebSocketSharp.Net.CookieCollection"/> that contains the cookies.
+    /// </value>
+    public override CookieCollection CookieCollection {
+      get {
+        return _context.Request.Cookies;
+      }
+    }
+
+    /// <summary>
+    /// Gets the HTTP headers used in the WebSocket opening handshake.
+    /// </summary>
+    /// <value>
+    /// A <see cref="System.Collections.Specialized.NameValueCollection"/> that contains the HTTP headers.
+    /// </value>
+    public override NameValueCollection Headers {
+      get {
+        return _context.Request.Headers;
+      }
+    }
+
+    /// <summary>
+    /// Gets a value indicating whether the client is authenticated.
+    /// </summary>
+    /// <value>
+    /// <c>true</c> if the client is authenticated; otherwise, <c>false</c>.
+    /// </value>
+    public override bool IsAuthenticated {
+      get {
+        return _context.Request.IsAuthenticated;
+      }
+    }
+
+    /// <summary>
+    /// Gets a value indicating whether the client connected from the local computer.
+    /// </summary>
+    /// <value>
+    /// <c>true</c> if the client connected from the local computer; otherwise, <c>false</c>.
+    /// </value>
+    public override bool IsLocal {
+      get {
+        return _context.Request.IsLocal;
+      }
+    }
+
+    /// <summary>
+    /// Gets a value indicating whether the WebSocket connection is secured.
+    /// </summary>
+    /// <value>
+    /// <c>true</c> if the WebSocket connection is secured; otherwise, <c>false</c>.
+    /// </value>
+    public override bool IsSecureConnection {
+      get {
+        return _context.Request.IsSecureConnection;
+      }
+    }
+
+    /// <summary>
+    /// Gets the value of the Origin header field used in the WebSocket opening handshake.
+    /// </summary>
+    /// <value>
+    /// A <see cref="string"/> that contains the value of the Origin header field.
+    /// </value>
+    public override string Origin {
+      get {
+        return Headers["Origin"];
+      }
+    }
+
+    /// <summary>
+    /// Gets the absolute path of the requested WebSocket URI.
+    /// </summary>
+    /// <value>
+    /// A <see cref="string"/> that contains the absolute path.
+    /// </value>
+    public virtual string Path {
+      get {
+        return RequestUri.GetAbsolutePath();
+      }
+    }
+
+    /// <summary>
+    /// Gets the WebSocket URI requested by the client.
+    /// </summary>
+    /// <value>
+    /// A <see cref="Uri"/> that contains the WebSocket URI.
+    /// </value>
+    public override Uri RequestUri {
+      get {
+        return _context.Request.RawUrl.ToUri();
+      }
+    }
+
+    /// <summary>
+    /// Gets the value of the Sec-WebSocket-Key header field used in the WebSocket opening handshake.
+    /// </summary>
+    /// <remarks>
+    /// The SecWebSocketKey property provides a part of the information used by the server to prove that it received a valid WebSocket opening handshake.
+    /// </remarks>
+    /// <value>
+    /// A <see cref="string"/> that contains the value of the Sec-WebSocket-Key header field.
+    /// </value>
+    public override string SecWebSocketKey {
+      get {
+        return Headers["Sec-WebSocket-Key"];
+      }
+    }
+
+    /// <summary>
+    /// Gets the values of the Sec-WebSocket-Protocol header field used in the WebSocket opening handshake.
+    /// </summary>
+    /// <remarks>
+    /// The SecWebSocketProtocols property indicates the subprotocols of the WebSocket connection.
+    /// </remarks>
+    /// <value>
+    /// An IEnumerable&lt;string&gt; that contains the values of the Sec-WebSocket-Protocol header field.
+    /// </value>
+    public override IEnumerable<string> SecWebSocketProtocols {
+      get {
+        return Headers.GetValues("Sec-WebSocket-Protocol");
+      }
+    }
+
+    /// <summary>
+    /// Gets the value of the Sec-WebSocket-Version header field used in the WebSocket opening handshake.
+    /// </summary>
+    /// <remarks>
+    /// The SecWebSocketVersion property indicates the WebSocket protocol version of the connection.
+    /// </remarks>
+    /// <value>
+    /// A <see cref="string"/> that contains the value of the Sec-WebSocket-Version header field.
+    /// </value>
+    public override string SecWebSocketVersion {
+      get {
+        return Headers["Sec-WebSocket-Version"];
+      }
+    }
+
+    /// <summary>
+    /// Gets the server endpoint as an IP address and a port number.
+    /// </summary>
+    /// <value>
+    /// A <see cref="System.Net.IPEndPoint"/> that contains the server endpoint.
+    /// </value>
+    public virtual System.Net.IPEndPoint ServerEndPoint {
+      get {
+        return _context.Connection.LocalEndPoint;
+      }
+    }
+
+    /// <summary>
+    /// Gets the client information (identity, authentication information and security roles).
+    /// </summary>
+    /// <value>
+    /// An <see cref="IPrincipal"/> that contains the client information.
+    /// </value>
+    public override IPrincipal User {
+      get {
+        return _context.User;
+      }
+    }
+
+    /// <summary>
+    /// Gets the client endpoint as an IP address and a port number.
+    /// </summary>
+    /// <value>
+    /// A <see cref="System.Net.IPEndPoint"/> that contains the client endpoint.
+    /// </value>
+    public virtual System.Net.IPEndPoint UserEndPoint {
+      get {
+        return _context.Connection.RemoteEndPoint;
+      }
+    }
+
+    /// <summary>
+    /// Gets the WebSocket instance used for two-way communication between client and server.
+    /// </summary>
+    /// <value>
+    /// A <see cref="WebSocketSharp.WebSocket"/>.
+    /// </value>
+    public override WebSocket WebSocket {
+      get {
+        return _socket;
+      }
+    }
+
+    #endregion
+  }
+}

websocket-sharp/Net/WebSockets/TcpListenerWebSocketContext.cs

@@ -0,0 +1,288 @@
+#region MIT License
+/*
+ * TcpListenerWebSocketContext.cs
+ *
+ * The MIT License
+ *
+ * Copyright (c) 2012-2013 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
+
+using System;
+using System.Collections.Generic;
+using System.Collections.Specialized;
+using System.Net.Sockets;
+using System.Security.Principal;
+
+namespace WebSocketSharp.Net.WebSockets {
+
+  /// <summary>
+  /// Provides access to the WebSocket connection request objects received by the <see cref="TcpListener"/> class.
+  /// </summary>
+  /// <remarks>
+  /// </remarks>
+  public class TcpListenerWebSocketContext : WebSocketContext
+  {
+    #region Fields
+
+    private TcpClient        _client;
+    private bool             _isSecure;
+    private RequestHandshake _request;
+    private WebSocket        _socket;
+    private WsStream         _stream;
+
+    #endregion
+
+    #region Constructor
+
+    internal TcpListenerWebSocketContext(TcpClient client, bool secure)
+    {
+      _client   = client;
+      _isSecure = secure;
+      _stream   = WsStream.CreateServerStream(client, secure);
+      _request  = RequestHandshake.Parse(_stream.ReadHandshake());
+      _socket   = new WebSocket(this);
+    }
+
+    #endregion
+
+    #region Internal Properties
+
+    internal TcpClient Client {
+      get {
+        return _client;
+      }
+    }
+
+    internal WsStream Stream {
+      get {
+        return _stream;
+      }
+    }
+
+    #endregion
+
+    #region Public Properties
+
+    /// <summary>
+    /// Gets the cookies used in the WebSocket opening handshake.
+    /// </summary>
+    /// <value>
+    /// A <see cref="WebSocketSharp.Net.CookieCollection"/> that contains the cookies.
+    /// </value>
+    /// <exception cref="NotImplementedException">
+    /// This property is not implemented.
+    /// </exception>
+    public override CookieCollection CookieCollection {
+      get {
+        throw new NotImplementedException();
+      }
+    }
+
+    /// <summary>
+    /// Gets the HTTP headers used in the WebSocket opening handshake.
+    /// </summary>
+    /// <value>
+    /// A <see cref="System.Collections.Specialized.NameValueCollection"/> that contains the HTTP headers.
+    /// </value>
+    public override NameValueCollection Headers {
+      get {
+        return _request.Headers;
+      }
+    }
+
+    /// <summary>
+    /// Gets a value indicating whether the client is authenticated.
+    /// </summary>
+    /// <value>
+    /// <c>true</c> if the client is authenticated; otherwise, <c>false</c>.
+    /// </value>
+    /// <exception cref="NotImplementedException">
+    /// This property is not implemented.
+    /// </exception>
+    public override bool IsAuthenticated {
+      get {
+        throw new NotImplementedException();
+      }
+    }
+
+    /// <summary>
+    /// Gets a value indicating whether the client connected from the local computer.
+    /// </summary>
+    /// <value>
+    /// <c>true</c> if the client connected from the local computer; otherwise, <c>false</c>.
+    /// </value>
+    /// <exception cref="NotImplementedException">
+    /// This property is not implemented.
+    /// </exception>
+    public override bool IsLocal {
+      get {
+        throw new NotImplementedException();
+      }
+    }
+
+    /// <summary>
+    /// Gets a value indicating whether the WebSocket connection is secured.
+    /// </summary>
+    /// <value>
+    /// <c>true</c> if the WebSocket connection is secured; otherwise, <c>false</c>.
+    /// </value>
+    public override bool IsSecureConnection {
+      get {
+        return _isSecure;
+      }
+    }
+
+    /// <summary>
+    /// Gets the value of the Origin header field used in the WebSocket opening handshake.
+    /// </summary>
+    /// <value>
+    /// A <see cref="string"/> that contains the value of the Origin header field.
+    /// </value>
+    public override string Origin {
+      get {
+        return Headers["Origin"];
+      }
+    }
+
+    /// <summary>
+    /// Gets the absolute path of the requested WebSocket URI.
+    /// </summary>
+    /// <value>
+    /// A <see cref="string"/> that contains the absolute path.
+    /// </value>
+    public virtual string Path {
+      get {
+        return _request.RequestUri.GetAbsolutePath();
+      }
+    }
+
+    /// <summary>
+    /// Gets the WebSocket URI requested by the client.
+    /// </summary>
+    /// <value>
+    /// A <see cref="Uri"/> that contains the WebSocket URI.
+    /// </value>
+    public override Uri RequestUri {
+      get {
+        return _request.RequestUri;
+      }
+    }
+
+    /// <summary>
+    /// Gets the value of the Sec-WebSocket-Key header field used in the WebSocket opening handshake.
+    /// </summary>
+    /// <remarks>
+    /// The SecWebSocketKey property provides a part of the information used by the server to prove that it received a valid WebSocket opening handshake.
+    /// </remarks>
+    /// <value>
+    /// A <see cref="string"/> that contains the value of the Sec-WebSocket-Key header field.
+    /// </value>
+    public override string SecWebSocketKey {
+      get {
+        return Headers["Sec-WebSocket-Key"];
+      }
+    }
+
+    /// <summary>
+    /// Gets the values of the Sec-WebSocket-Protocol header field used in the WebSocket opening handshake.
+    /// </summary>
+    /// <remarks>
+    /// The SecWebSocketProtocols property indicates the subprotocols of the WebSocket connection.
+    /// </remarks>
+    /// <value>
+    /// An IEnumerable&lt;string&gt; that contains the values of the Sec-WebSocket-Protocol header field.
+    /// </value>
+    public override IEnumerable<string> SecWebSocketProtocols {
+      get {
+        return Headers.GetValues("Sec-WebSocket-Protocol");
+      }
+    }
+
+    /// <summary>
+    /// Gets the value of the Sec-WebSocket-Version header field used in the WebSocket opening handshake.
+    /// </summary>
+    /// <remarks>
+    /// The SecWebSocketVersion property indicates the WebSocket protocol version of the connection.
+    /// </remarks>
+    /// <value>
+    /// A <see cref="string"/> that contains the value of the Sec-WebSocket-Version header field.
+    /// </value>
+    public override string SecWebSocketVersion {
+      get {
+        return Headers["Sec-WebSocket-Version"];
+      }
+    }
+
+    /// <summary>
+    /// Gets the server endpoint as an IP address and a port number.
+    /// </summary>
+    /// <value>
+    /// A <see cref="System.Net.IPEndPoint"/> that contains the server endpoint.
+    /// </value>
+    public virtual System.Net.IPEndPoint ServerEndPoint {
+      get {
+        return (System.Net.IPEndPoint)_client.Client.LocalEndPoint;
+      }
+    }
+
+    /// <summary>
+    /// Gets the client information (identity, authentication information and security roles).
+    /// </summary>
+    /// <value>
+    /// An <see cref="IPrincipal"/> that contains the client information.
+    /// </value>
+    /// <exception cref="NotImplementedException">
+    /// This property is not implemented.
+    /// </exception>
+    public override IPrincipal User {
+      get {
+        throw new NotImplementedException();
+      }
+    }
+
+    /// <summary>
+    /// Gets the client endpoint as an IP address and a port number.
+    /// </summary>
+    /// <value>
+    /// A <see cref="System.Net.IPEndPoint"/> that contains the client endpoint.
+    /// </value>
+    public virtual System.Net.IPEndPoint UserEndPoint {
+      get {
+        return (System.Net.IPEndPoint)_client.Client.RemoteEndPoint;
+      }
+    }
+
+    /// <summary>
+    /// Gets the WebSocket instance used for two-way communication between client and server.
+    /// </summary>
+    /// <value>
+    /// A <see cref="WebSocketSharp.WebSocket"/>.
+    /// </value>
+    public override WebSocket WebSocket {
+      get {
+        return _socket;
+      }
+    }
+
+    #endregion
+  }
+}

websocket-sharp/Net/WebSockets/WebSocketContext.cs

@@ -0,0 +1,164 @@
+#region MIT License
+/*
+ * WebSocketContext.cs
+ *
+ * The MIT License
+ *
+ * Copyright (c) 2012-2013 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
+
+using System;
+using System.Collections.Generic;
+using System.Collections.Specialized;
+using System.Security.Principal;
+
+namespace WebSocketSharp.Net.WebSockets {
+
+  /// <summary>
+  /// Provides access to the WebSocket connection request objects.
+  /// </summary>
+  /// <remarks>
+  /// The WebSocketContext class is an abstract class.
+  /// </remarks>
+  public abstract class WebSocketContext {
+
+    #region Constructor
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="WebSocketSharp.Net.WebSockets.WebSocketContext"/> class.
+    /// </summary>
+    protected WebSocketContext()
+    {
+    }
+
+    #endregion
+
+    #region Properties
+
+    /// <summary>
+    /// Gets the cookies used in the WebSocket opening handshake.
+    /// </summary>
+    /// <value>
+    /// A <see cref="WebSocketSharp.Net.CookieCollection"/> that contains the cookies.
+    /// </value>
+    public abstract CookieCollection CookieCollection { get; }
+
+    /// <summary>
+    /// Gets the HTTP headers used in the WebSocket opening handshake.
+    /// </summary>
+    /// <value>
+    /// A <see cref="System.Collections.Specialized.NameValueCollection"/> that contains the HTTP headers.
+    /// </value>
+    public abstract NameValueCollection Headers { get; }
+
+    /// <summary>
+    /// Gets a value indicating whether the client is authenticated.
+    /// </summary>
+    /// <value>
+    /// <c>true</c> if the client is authenticated; otherwise, <c>false</c>.
+    /// </value>
+    public abstract bool IsAuthenticated { get; }
+
+    /// <summary>
+    /// Gets a value indicating whether the client connected from the local computer.
+    /// </summary>
+    /// <value>
+    /// <c>true</c> if the client connected from the local computer; otherwise, <c>false</c>.
+    /// </value>
+    public abstract bool IsLocal { get; }
+
+    /// <summary>
+    /// Gets a value indicating whether the WebSocket connection is secured.
+    /// </summary>
+    /// <value>
+    /// <c>true</c> if the WebSocket connection is secured; otherwise, <c>false</c>.
+    /// </value>
+    public abstract bool IsSecureConnection { get; }
+
+    /// <summary>
+    /// Gets the value of the Origin header field used in the WebSocket opening handshake.
+    /// </summary>
+    /// <value>
+    /// A <see cref="string"/> that contains the value of the Origin header field.
+    /// </value>
+    public abstract string Origin { get; }
+
+    /// <summary>
+    /// Gets the WebSocket URI requested by the client.
+    /// </summary>
+    /// <value>
+    /// A <see cref="Uri"/> that contains the WebSocket URI.
+    /// </value>
+    public abstract Uri RequestUri { get; }
+
+    /// <summary>
+    /// Gets the value of the Sec-WebSocket-Key header field used in the WebSocket opening handshake.
+    /// </summary>
+    /// <remarks>
+    /// The SecWebSocketKey property provides a part of the information used by the server to prove that it received a valid WebSocket opening handshake.
+    /// </remarks>
+    /// <value>
+    /// A <see cref="string"/> that contains the value of the Sec-WebSocket-Key header field.
+    /// </value>
+    public abstract string SecWebSocketKey { get; }
+
+    /// <summary>
+    /// Gets the values of the Sec-WebSocket-Protocol header field used in the WebSocket opening handshake.
+    /// </summary>
+    /// <remarks>
+    /// The SecWebSocketProtocols property indicates the subprotocols of the WebSocket connection.
+    /// </remarks>
+    /// <value>
+    /// An IEnumerable&lt;string&gt; that contains the values of the Sec-WebSocket-Protocol header field.
+    /// </value>
+    public abstract IEnumerable<string> SecWebSocketProtocols { get; }
+
+    /// <summary>
+    /// Gets the value of the Sec-WebSocket-Version header field used in the WebSocket opening handshake.
+    /// </summary>
+    /// <remarks>
+    /// The SecWebSocketVersion property indicates the WebSocket protocol version of the connection.
+    /// </remarks>
+    /// <value>
+    /// A <see cref="string"/> that contains the value of the Sec-WebSocket-Version header field.
+    /// </value>
+    public abstract string SecWebSocketVersion { get; }
+
+    /// <summary>
+    /// Gets the client information (identity, authentication information and security roles).
+    /// </summary>
+    /// <value>
+    /// An <see cref="IPrincipal"/> that contains the client information.
+    /// </value>
+    public abstract IPrincipal User { get; }
+
+    /// <summary>
+    /// Gets the WebSocket instance used for two-way communication between client and server.
+    /// </summary>
+    /// <value>
+    /// A <see cref="WebSocketSharp.WebSocket"/>.
+    /// </value>
+    public abstract WebSocket WebSocket { get; }
+
+    #endregion
+  }
+}