DevWiki/websocket-sharp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added some XML documentation comments

Browse Source
This commit is contained in:
sta
2013-01-22 20:46:32 +09:00
parent e4ffa090d3
commit de3f41dd3a
161 changed files with 4683 additions and 4245 deletions
Download Patch File Download Diff File Expand all files Collapse all files

228
websocket-sharp/Net/Cookie.cs
View File

@@ -1,6 +1,6 @@
//
// Cookie.cs
// Copied from System.Net.Cookie
// Copied from System.Net.Cookie.cs
//
// Authors:
// Lawrence Pit (loz@cable.a2000.nl)
@@ -45,6 +45,12 @@ namespace WebSocketSharp.Net {
[Serializable]
public sealed class Cookie
{
#region Fields
static char [] reservedCharsName = new char [] {' ', '=', ';', ',', '\n', '\r', '\t'};
static char [] portSeparators = new char [] {'"', ','};
static string tspecials = "()<>@,;:\\\"/[]?={} \t"; // from RFC 2965, 2068
string comment;
Uri commentUri;
bool discard;
@@ -59,10 +65,10 @@ namespace WebSocketSharp.Net {
DateTime timestamp;
string val;
int version;
static char [] reservedCharsName = new char [] {' ', '=', ';', ',', '\n', '\r', '\t'};
static char [] portSeparators = new char [] {'"', ','};
static string tspecials = "()<>@,;:\\\"/[]?={} \t"; // from RFC 2965, 2068
#endregion
#region Constructors
public Cookie ()
{
@@ -94,6 +100,20 @@ namespace WebSocketSharp.Net {
Domain = domain;
}
#endregion
#region Internal Properties
internal bool ExactDomain { get; set; }
internal int [] Ports {
get { return ports; }
}
#endregion
#region Public Properties
public string Comment {
get { return comment; }
set { comment = value == null ? String.Empty : value; }
@@ -122,8 +142,6 @@ namespace WebSocketSharp.Net {
}
}
internal bool ExactDomain { get; set; }
public bool Expired {
get {
return expires <= DateTime.Now &&
@@ -157,7 +175,7 @@ namespace WebSocketSharp.Net {
name = String.Empty;
throw new CookieException ("Name contains invalid characters");
}
name = value;
}
}
@@ -184,7 +202,7 @@ namespace WebSocketSharp.Net {
ports [i] = Int32.MinValue;
if (values [i].Length == 0)
continue;
try {
try {
ports [i] = Int32.Parse (values [i]);
} catch (Exception e) {
throw new CookieException("The 'Port'='" + value + "' part of the cookie is invalid. Invalid value: " + values [i], e);
@@ -194,10 +212,6 @@ namespace WebSocketSharp.Net {
}
}
internal int [] Ports {
get { return ports; }
}
public bool Secure {
get { return secure; }
set { secure = value; }
@@ -214,7 +228,7 @@ namespace WebSocketSharp.Net {
val = String.Empty;
return;
}
// LAMESPEC: According to .Net specs the Value property should not accept
// the semicolon and comma characters, yet it does. For now we'll follow
// the behaviour of MS.Net instead of the specs.
@@ -222,7 +236,7 @@ namespace WebSocketSharp.Net {
if (value.IndexOfAny(reservedCharsValue) != -1)
throw new CookieException("Invalid value. Value cannot contain semicolon or comma characters.");
*/
val = value;
}
}
@@ -237,16 +251,107 @@ namespace WebSocketSharp.Net {
}
}
public override bool Equals (Object obj)
#endregion
#region Private Methods
private static int hash (int i, int j, int k, int l, int m)
{
System.Net.Cookie c = obj as System.Net.Cookie;
return i ^ (j << 13 | j >> 19) ^ (k << 26 | k >> 6) ^ (l << 7 | l >> 25) ^ (m << 20 | m >> 12);
}
bool IsToken (string value)
{
int len = value.Length;
for (int i = 0; i < len; i++) {
char c = value [i];
if (c < 0x20 || c >= 0x7f || tspecials.IndexOf (c) != -1)
return false;
}
return true;
}
// See par 3.6 of RFC 2616
string QuotedString (string value)
{
if (version == 0 || IsToken (value))
return value;
else
return "\"" + value.Replace("\"", "\\\"") + "\"";
}
#endregion
#region Internal Methods
internal string ToClientString ()
{
if (name.Length == 0)
return String.Empty;
StringBuilder result = new StringBuilder (64);
if (version > 0)
result.Append ("Version=").Append (version).Append (";");
result.Append (name).Append ("=").Append (val);
if (path != null && path.Length != 0)
result.Append (";Path=").Append (QuotedString (path));
if (domain != null && domain.Length != 0)
result.Append (";Domain=").Append (QuotedString (domain));
if (port != null && port.Length != 0)
result.Append (";Port=").Append (port);
return result.ToString ();
}
internal string ToString (Uri uri)
{
if (name.Length == 0)
return String.Empty;
StringBuilder result = new StringBuilder (64);
if (version > 0)
result.Append ("$Version=").Append (version).Append ("; ");
result.Append (name).Append ("=").Append (val);
if (version == 0)
return result.ToString ();
if (!String.IsNullOrEmpty (path))
result.Append ("; $Path=").Append (path);
else if (uri != null)
result.Append ("; $Path=/").Append (path);
bool append_domain = (uri == null) || (uri.Host != domain);
if (append_domain && !String.IsNullOrEmpty (domain))
result.Append ("; $Domain=").Append (domain);
if (port != null && port.Length != 0)
result.Append ("; $Port=").Append (port);
return result.ToString ();
}
#endregion
#region Public Methods
public override bool Equals (Object obj)
{
Cookie c = obj as Cookie;
return c != null &&
String.Compare (this.name, c.Name, true, CultureInfo.InvariantCulture) == 0 &&
String.Compare (this.val, c.Value, false, CultureInfo.InvariantCulture) == 0 &&
String.Compare (this.Path, c.Path, false, CultureInfo.InvariantCulture) == 0 &&
String.Compare (this.domain, c.Domain, true, CultureInfo.InvariantCulture) == 0 &&
this.version == c.Version;
String.Compare (this.name, c.Name, true, CultureInfo.InvariantCulture) == 0 &&
String.Compare (this.val, c.Value, false, CultureInfo.InvariantCulture) == 0 &&
String.Compare (this.Path, c.Path, false, CultureInfo.InvariantCulture) == 0 &&
String.Compare (this.domain, c.Domain, true, CultureInfo.InvariantCulture) == 0 &&
this.version == c.Version;
}
public override int GetHashCode ()
@@ -259,11 +364,6 @@ namespace WebSocketSharp.Net {
version);
}
private static int hash (int i, int j, int k, int l, int m)
{
return i ^ (j << 13 | j >> 19) ^ (k << 26 | k >> 6) ^ (l << 7 | l >> 25) ^ (m << 20 | m >> 12);
}
// returns a string that can be used to send a cookie to an Origin Server
// i.e., only used for clients
// see para 4.2.2 of RFC 2109 and para 3.3.4 of RFC 2965
@@ -273,78 +373,6 @@ namespace WebSocketSharp.Net {
return ToString (null);
}
internal string ToString (Uri uri)
{
if (name.Length == 0)
return String.Empty;
StringBuilder result = new StringBuilder (64);
if (version > 0)
result.Append ("$Version=").Append (version).Append ("; ");
result.Append (name).Append ("=").Append (val);
if (version == 0)
return result.ToString ();
if (!String.IsNullOrEmpty (path))
result.Append ("; $Path=").Append (path);
else if (uri != null)
result.Append ("; $Path=/").Append (path);
bool append_domain = (uri == null) || (uri.Host != domain);
if (append_domain && !String.IsNullOrEmpty (domain))
result.Append ("; $Domain=").Append (domain);
if (port != null && port.Length != 0)
result.Append ("; $Port=").Append (port);
return result.ToString ();
}
internal string ToClientString ()
{
if (name.Length == 0)
return String.Empty;
StringBuilder result = new StringBuilder (64);
if (version > 0)
result.Append ("Version=").Append (version).Append (";");
result.Append (name).Append ("=").Append (val);
if (path != null && path.Length != 0)
result.Append (";Path=").Append (QuotedString (path));
if (domain != null && domain.Length != 0)
result.Append (";Domain=").Append (QuotedString (domain));
if (port != null && port.Length != 0)
result.Append (";Port=").Append (port);
return result.ToString ();
}
// See par 3.6 of RFC 2616
string QuotedString (string value)
{
if (version == 0 || IsToken (value))
return value;
else
return "\"" + value.Replace("\"", "\\\"") + "\"";
}
bool IsToken (string value)
{
int len = value.Length;
for (int i = 0; i < len; i++) {
char c = value [i];
if (c < 0x20 || c >= 0x7f || tspecials.IndexOf (c) != -1)
return false;
}
return true;
}
#endregion
}
}

141
websocket-sharp/Net/CookieCollection.cs
View File

@@ -1,6 +1,6 @@
//
// CookieCollection.cs
// Copied from System.Net.CookieCollection
// Copied from System.Net.CookieCollection.cs
//
// Authors:
// Lawrence Pit (loz@cable.a2000.nl)
@@ -56,69 +56,66 @@ namespace WebSocketSharp.Net {
}
}
static CookieCollectionComparer Comparer = new CookieCollectionComparer ();
#region Fields
static CookieCollectionComparer Comparer = new CookieCollectionComparer ();
List<Cookie> list = new List<Cookie> ();
#endregion
#region Internal Property
internal IList<Cookie> List {
get { return list; }
}
#endregion
#region Public Properties
// ICollection
public int Count {
get { return list.Count; }
}
public bool IsSynchronized {
get { return false; }
}
public Object SyncRoot {
get { return this; }
}
public void CopyTo (Array array, int index)
{
(list as IList).CopyTo (array, index);
}
public void CopyTo (Cookie [] array, int index)
{
list.CopyTo (array, index);
}
// IEnumerable
public IEnumerator GetEnumerator ()
{
return list.GetEnumerator ();
}
// This
// LAMESPEC: So how is one supposed to create a writable CookieCollection
// instance?? We simply ignore this property, as this collection is always
// writable.
public bool IsReadOnly {
get { return true; }
}
public void Add (Cookie cookie)
{
if (cookie == null)
throw new ArgumentNullException ("cookie");
int pos = SearchCookie (cookie);
if (pos == -1)
list.Add (cookie);
else
list [pos] = cookie;
}
internal void Sort ()
{
if (list.Count > 0)
list.Sort (Comparer);
public bool IsSynchronized {
get { return false; }
}
public Cookie this [int index] {
get {
if (index < 0 || index >= list.Count)
throw new ArgumentOutOfRangeException ("index");
return list [index];
}
}
public Cookie this [string name] {
get {
foreach (Cookie c in list) {
if (0 == String.Compare (c.Name, name, true, CultureInfo.InvariantCulture))
return c;
}
return null;
}
}
public Object SyncRoot {
get { return this; }
}
#endregion
#region Private Method
int SearchCookie (Cookie cookie)
{
string name = cookie.Name;
@@ -145,6 +142,32 @@ namespace WebSocketSharp.Net {
return -1;
}
#endregion
#region Internal Method
internal void Sort ()
{
if (list.Count > 0)
list.Sort (Comparer);
}
#endregion
#region Public Methods
public void Add (Cookie cookie)
{
if (cookie == null)
throw new ArgumentNullException ("cookie");
int pos = SearchCookie (cookie);
if (pos == -1)
list.Add (cookie);
else
list [pos] = cookie;
}
public void Add (CookieCollection cookies)
{
if (cookies == null)
@@ -154,23 +177,21 @@ namespace WebSocketSharp.Net {
Add (c);
}
public Cookie this [int index] {
get {
if (index < 0 || index >= list.Count)
throw new ArgumentOutOfRangeException ("index");
return list [index];
}
public void CopyTo (Array array, int index)
{
(list as IList).CopyTo (array, index);
}
public Cookie this [string name] {
get {
foreach (Cookie c in list) {
if (0 == String.Compare (c.Name, name, true, CultureInfo.InvariantCulture))
return c;
}
return null;
}
public void CopyTo (Cookie [] array, int index)
{
list.CopyTo (array, index);
}
public IEnumerator GetEnumerator ()
{
return list.GetEnumerator ();
}
#endregion
}
}

5
websocket-sharp/Net/HttpListenerContext.cs
View File

@@ -1,12 +1,12 @@
//
// HttpListenerContext.cs
// Copied from System.Net.HttpListenerContext
// Copied from System.Net.HttpListenerContext.cs
//
// Author:
// Gonzalo Paniagua Javier (gonzalo@novell.com)
//
// Copyright (c) 2005 Novell, Inc. (http://www.novell.com)
// Copyright (c) 2012 sta.blockhead (sta.blockhead@gmail.com)
// Copyright (c) 2012-2013 sta.blockhead (sta.blockhead@gmail.com)
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
@@ -34,6 +34,7 @@ using System.IO;
using System.Net;
using System.Security.Principal;
using System.Text;
using WebSocketSharp.Net.WebSockets;
namespace WebSocketSharp.Net {

151
websocket-sharp/Net/HttpListenerWebSocketContext.cs
View File

@@ -1,151 +0,0 @@
#region MIT License
/*
* HttpListenerWebSocketContext.cs
*
* The MIT License
*
* Copyright (c) 2012 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 {
public class HttpListenerWebSocketContext : WebSocketContext
{
private HttpListenerContext _context;
private WebSocket _socket;
private WsStream _stream;
internal HttpListenerWebSocketContext(HttpListenerContext context)
{
_context = context;
_stream = WsStream.CreateServerStream(context);
_socket = new WebSocket(this);
}
internal HttpListenerContext BaseContext {
get {
return _context;
}
}
internal WsStream Stream {
get {
return _stream;
}
}
public override CookieCollection CookieCollection {
get {
return _context.Request.Cookies;
}
}
public override NameValueCollection Headers {
get {
return _context.Request.Headers;
}
}
public override bool IsAuthenticated {
get {
return _context.Request.IsAuthenticated;
}
}
public override bool IsSecureConnection {
get {
return _context.Request.IsSecureConnection;
}
}
public override bool IsLocal {
get {
return _context.Request.IsLocal;
}
}
public override string Origin {
get {
return Headers["Origin"];
}
}
public virtual string Path {
get {
return RequestUri.GetAbsolutePath();
}
}
public override Uri RequestUri {
get {
return _context.Request.RawUrl.ToUri();
}
}
public override string SecWebSocketKey {
get {
return Headers["Sec-WebSocket-Key"];
}
}
public override IEnumerable<string> SecWebSocketProtocols {
get {
return Headers.GetValues("Sec-WebSocket-Protocol");
}
}
public override string SecWebSocketVersion {
get {
return Headers["Sec-WebSocket-Version"];
}
}
public virtual System.Net.IPEndPoint ServerEndPoint {
get {
return _context.Connection.LocalEndPoint;
}
}
public override IPrincipal User {
get {
return _context.User;
}
}
public virtual System.Net.IPEndPoint UserEndPoint {
get {
return _context.Connection.RemoteEndPoint;
}
}
public override WebSocket WebSocket {
get {
return _socket;
}
}
}
}

157
websocket-sharp/Net/Sockets/TcpListenerWebSocketContext.cs
View File

@@ -1,157 +0,0 @@
#region MIT License
/*
* TcpListenerWebSocketContext.cs
*
* The MIT License
*
* Copyright (c) 2012 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;
using System.Net.Sockets;
using System.Security.Principal;
namespace WebSocketSharp.Net.Sockets {
public class TcpListenerWebSocketContext : WebSocketContext
{
private TcpClient _client;
private bool _isSecure;
private RequestHandshake _request;
private WebSocket _socket;
private WsStream _stream;
internal TcpListenerWebSocketContext(TcpClient client, bool secure)
{
_client = client;
_isSecure = secure;
_stream = WsStream.CreateServerStream(client, secure);
_request = RequestHandshake.Parse(_stream.ReadHandshake());
_socket = new WebSocket(this);
}
internal TcpClient Client {
get {
return _client;
}
}
internal WsStream Stream {
get {
return _stream;
}
}
public override CookieCollection CookieCollection {
get {
throw new NotImplementedException();
}
}
public override NameValueCollection Headers {
get {
return _request.Headers;
}
}
public override bool IsAuthenticated {
get {
throw new NotImplementedException();
}
}
public override bool IsSecureConnection {
get {
return _isSecure;
}
}
public override bool IsLocal {
get {
throw new NotImplementedException();
}
}
public override string Origin {
get {
return Headers["Origin"];
}
}
public virtual string Path {
get {
return _request.RequestUri.GetAbsolutePath();
}
}
public override Uri RequestUri {
get {
return _request.RequestUri;
}
}
public override string SecWebSocketKey {
get {
return Headers["Sec-WebSocket-Key"];
}
}
public override IEnumerable<string> SecWebSocketProtocols {
get {
return Headers.GetValues("Sec-WebSocket-Protocol");
}
}
public override string SecWebSocketVersion {
get {
return Headers["Sec-WebSocket-Version"];
}
}
public virtual IPEndPoint ServerEndPoint {
get {
return (IPEndPoint)_client.Client.LocalEndPoint;
}
}
public override IPrincipal User {
get {
throw new NotImplementedException();
}
}
public virtual IPEndPoint UserEndPoint {
get {
return (IPEndPoint)_client.Client.RemoteEndPoint;
}
}
public override WebSocket WebSocket {
get {
return _socket;
}
}
}
}

55
websocket-sharp/Net/WebSocketContext.cs
View File

@@ -1,55 +0,0 @@
#region MIT License
/*
* WebSocketContext.cs
*
* The MIT License
*
* Copyright (c) 2012 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 {
public abstract class WebSocketContext {
protected WebSocketContext()
{
}
public abstract CookieCollection CookieCollection { get; }
public abstract NameValueCollection Headers { get; }
public abstract bool IsAuthenticated { get; }
public abstract bool IsSecureConnection { get; }
public abstract bool IsLocal { get; }
public abstract string Origin { get; }
public abstract Uri RequestUri { get; }
public abstract string SecWebSocketKey { get; }
public abstract IEnumerable<string> SecWebSocketProtocols { get; }
public abstract string SecWebSocketVersion { get; }
public abstract IPrincipal User { get; }
public abstract WebSocket WebSocket { get; }
}
}

271
websocket-sharp/Net/WebSockets/HttpListenerWebSocketContext.cs Normal file
View File

@@ -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
}
}

288
websocket-sharp/Net/WebSockets/TcpListenerWebSocketContext.cs Normal file
View File

@@ -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
}
}

164
websocket-sharp/Net/WebSockets/WebSocketContext.cs Normal file
View File

@@ -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
}
}