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

12
websocket-sharp/Server/IServiceHost.cs
View File

@@ -4,7 +4,7 @@
*
* The MIT License
*
* Copyright (c) 2012 sta.blockhead
* 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
@@ -38,19 +38,21 @@ namespace WebSocketSharp.Server {
public interface IServiceHost {
/// <summary>
/// Indicates whether the WebSocket service host closes the connection to a inactive service client.
/// Gets or sets a value indicating whether the WebSocket service host cleans up the inactive service client.
/// </summary>
/// <value>
/// <c>true</c> if the WebSocket service host closes the connection to a inactive service client; otherwise, <c>false</c>.
/// <c>true</c> if the WebSocket service host cleans up the inactive service client; otherwise, <c>false</c>.
/// </value>
bool Sweeped { get; set; }
/// <summary>
/// Binds the specified <see cref="WebSocketSharp.WebSocket"/>.
/// Binds the specified <see cref="WebSocket"/> instance to the WebSocket service.
/// </summary>
/// <param name="socket">
/// An <see cref="WebSocketSharp.WebSocket"/> to bind.
/// </param>
void BindWebSocket(WebSocket socket);
/// <summary>
/// Broadcasts the specified <see cref="string"/>.
/// </summary>
@@ -58,10 +60,12 @@ namespace WebSocketSharp.Server {
/// A <see cref="string"/> to broadcast.
/// </param>
void Broadcast(string data);
/// <summary>
/// Starts the WebSocket service host.
/// </summary>
void Start();
/// <summary>
/// Stops the WebSocket service host.
/// </summary>

97
websocket-sharp/Server/WebSocketServer.cs
View File

@@ -6,7 +6,7 @@
*
* The MIT License
*
* Copyright (c) 2012 sta.blockhead
* 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
@@ -32,9 +32,16 @@ using System;
using System.Collections.Generic;
using System.Net.Sockets;
using WebSocketSharp.Net;
using WebSocketSharp.Net.WebSockets;
namespace WebSocketSharp.Server {
/// <summary>
/// Provides the functions of the server that receives the WebSocket connection requests.
/// </summary>
/// <remarks>
/// The WebSocketServer class provides multi WebSocket service.
/// </remarks>
public class WebSocketServer : WebSocketServerBase
{
#region Field
@@ -45,16 +52,33 @@ namespace WebSocketSharp.Server {
#region Public Constructors
/// <summary>
/// Initializes a new instance of the WebSocketServer class.
/// </summary>
public WebSocketServer()
: this(80)
{
}
/// <summary>
/// Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
/// on the specified <paramref name="port"/>.
/// </summary>
/// <param name="port">
/// An <see cref="int"/> that contains a port number.
/// </param>
public WebSocketServer(int port)
: this(System.Net.IPAddress.Any, port)
{
}
/// <summary>
/// Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
/// on the specified WebSocket URL.
/// </summary>
/// <param name="url">
/// A <see cref="string"/> that contains a WebSocket URL.
/// </param>
public WebSocketServer(string url)
: base(url)
{
@@ -67,16 +91,49 @@ namespace WebSocketSharp.Server {
init();
}
/// <summary>
/// Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
/// on the specified <paramref name="port"/> and <paramref name="secure"/>.
/// </summary>
/// <param name="port">
/// An <see cref="int"/> that contains a port number.
/// </param>
/// <param name="secure">
/// A <see cref="bool"/> that indicates providing a secure connection or not. (<c>true</c> indicates providing a secure connection.)
/// </param>
public WebSocketServer(int port, bool secure)
: this(System.Net.IPAddress.Any, port, secure)
{
}
/// <summary>
/// Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
/// on the specified <paramref name="address"/> and <paramref name="port"/>.
/// </summary>
/// <param name="address">
/// An <see cref="System.Net.IPAddress"/> that contains an IP address.
/// </param>
/// <param name="port">
/// An <see cref="int"/> that contains a port number.
/// </param>
public WebSocketServer(System.Net.IPAddress address, int port)
: this(address, port, port == 443 ? true : false)
{
}
/// <summary>
/// Initializes a new instance of the WebSocketServer class that listens for incoming connection attempts
/// on the specified <paramref name="address"/>, <paramref name="port"/> and <paramref name="secure"/>.
/// </summary>
/// <param name="address">
/// An <see cref="System.Net.IPAddress"/> that contains an IP address.
/// </param>
/// <param name="port">
/// An <see cref="int"/> that contains a port number.
/// </param>
/// <param name="secure">
/// A <see cref="bool"/> that indicates providing a secure connection or not. (<c>true</c> indicates providing a secure connection.)
/// </param>
public WebSocketServer(System.Net.IPAddress address, int port, bool secure)
: base(address, port, "/", secure)
{
@@ -85,8 +142,14 @@ namespace WebSocketSharp.Server {
#endregion
#region Property
#region Properties
/// <summary>
/// Gets the service paths.
/// </summary>
/// <value>
/// An IEnumerable&lt;string&gt; that contains the service paths.
/// </value>
public IEnumerable<string> ServicePath {
get {
var url = BaseUri.IsAbsoluteUri
@@ -97,6 +160,12 @@ namespace WebSocketSharp.Server {
}
}
/// <summary>
/// Gets or sets a value indicating whether the server cleans up the inactive client.
/// </summary>
/// <value>
/// <c>true</c> if the server cleans up the inactive client; otherwise, <c>false</c>.
/// </value>
public bool Sweeped {
get {
return _services.Sweeped;
@@ -120,6 +189,12 @@ namespace WebSocketSharp.Server {
#region Protected Method
/// <summary>
/// Accepts the WebSocket connection.
/// </summary>
/// <param name="client">
/// A <see cref="TcpClient"/> that contains the TCP connection.
/// </param>
protected override void AcceptWebSocket(TcpClient client)
{
var context = client.AcceptWebSocket(IsSecure);
@@ -143,6 +218,15 @@ namespace WebSocketSharp.Server {
#region Public Methods
/// <summary>
/// Adds the WebSocket service.
/// </summary>
/// <param name="absPath">
/// A <see cref="string"/> that contains an absolute path associated with the WebSocket service.
/// </param>
/// <typeparam name="T">
/// The type of the WebSocket service. The T must inherit the <see cref="WebSocketService"/> class.
/// </typeparam>
public void AddService<T>(string absPath)
where T : WebSocketService, new()
{
@@ -163,11 +247,20 @@ namespace WebSocketSharp.Server {
_services.Add(absPath, svcHost);
}
/// <summary>
/// Broadcasts the specified <see cref="string"/>.
/// </summary>
/// <param name="data">
/// A <see cref="string"/> to broadcast.
/// </param>
public void Broadcast(string data)
{
_services.Broadcast(data);
}
/// <summary>
/// Stops receiving the WebSocket connection requests.
/// </summary>
public override void Stop()
{
base.Stop();

146
websocket-sharp/Server/WebSocketServiceHost.cs
View File

@@ -6,7 +6,7 @@
*
* The MIT License
*
* Copyright (c) 2012 sta.blockhead
* 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
@@ -35,6 +35,15 @@ using WebSocketSharp.Net;
namespace WebSocketSharp.Server {
/// <summary>
/// Provides the functions of the server that receives the WebSocket connection requests.
/// </summary>
/// <remarks>
/// The WebSocketServiceHost&lt;T&gt; class provides single WebSocket service.
/// </remarks>
/// <typeparam name="T">
/// The type of the WebSocket service that the server provides. The T must inherit the <see cref="WebSocketService"/> class.
/// </typeparam>
public class WebSocketServiceHost<T> : WebSocketServerBase, IServiceHost
where T : WebSocketService, new()
{
@@ -55,37 +64,113 @@ namespace WebSocketSharp.Server {
#region Public Constructors
/// <summary>
/// Initializes a new instance of the WebSocketServiceHost&lt;T&gt; class that listens for incoming connection attempts
/// on the specified <paramref name="port"/>.
/// </summary>
/// <param name='port'>
/// An <see cref="int"/> that contains a port number.
/// </param>
public WebSocketServiceHost(int port)
: this(port, "/")
{
}
/// <summary>
/// Initializes a new instance of the WebSocketServiceHost&lt;T&gt; class that listens for incoming connection attempts
/// on the specified WebSocket URL.
/// </summary>
/// <param name="url">
/// A <see cref="string"/> that contains a WebSocket URL.
/// </param>
public WebSocketServiceHost(string url)
: base(url)
{
init();
}
/// <summary>
/// Initializes a new instance of the WebSocketServiceHost&lt;T&gt; class that listens for incoming connection attempts
/// on the specified <paramref name="port"/> and <paramref name="secure"/>.
/// </summary>
/// <param name="port">
/// An <see cref="int"/> that contains a port number.
/// </param>
/// <param name="secure">
/// A <see cref="bool"/> that indicates providing a secure connection or not. (<c>true</c> indicates providing a secure connection.)
/// </param>
public WebSocketServiceHost(int port, bool secure)
: this(port, "/", secure)
{
}
/// <summary>
/// Initializes a new instance of the WebSocketServiceHost&lt;T&gt; class that listens for incoming connection attempts
/// on the specified <paramref name="port"/> and <paramref name="absPath"/>.
/// </summary>
/// <param name="port">
/// An <see cref="int"/> that contains a port number.
/// </param>
/// <param name="absPath">
/// A <see cref="string"/> that contains an absolute path.
/// </param>
public WebSocketServiceHost(int port, string absPath)
: this(System.Net.IPAddress.Any, port, absPath)
{
}
/// <summary>
/// Initializes a new instance of the WebSocketServiceHost&lt;T&gt; class that listens for incoming connection attempts
/// on the specified <paramref name="port"/>, <paramref name="absPath"/> and <paramref name="secure"/>.
/// </summary>
/// <param name="port">
/// An <see cref="int"/> that contains a port number.
/// </param>
/// <param name="absPath">
/// A <see cref="string"/> that contains an absolute path.
/// </param>
/// <param name="secure">
/// A <see cref="bool"/> that indicates providing a secure connection or not. (<c>true</c> indicates providing a secure connection.)
/// </param>
public WebSocketServiceHost(int port, string absPath, bool secure)
: this(System.Net.IPAddress.Any, port, absPath, secure)
{
}
/// <summary>
/// Initializes a new instance of the WebSocketServiceHost&lt;T&gt; class that listens for incoming connection attempts
/// on the specified <paramref name="address"/>, <paramref name="port"/> and <paramref name="absPath"/>.
/// </summary>
/// <param name="address">
/// An <see cref="System.Net.IPAddress"/> that contains an IP address.
/// </param>
/// <param name="port">
/// An <see cref="int"/> that contains a port number.
/// </param>
/// <param name="absPath">
/// A <see cref="string"/> that contains an absolute path.
/// </param>
public WebSocketServiceHost(System.Net.IPAddress address, int port, string absPath)
: this(address, port, absPath, port == 443 ? true : false)
{
}
/// <summary>
/// Initializes a new instance of the WebSocketServiceHost&lt;T&gt; class that listens for incoming connection attempts
/// on the specified <paramref name="address"/>, <paramref name="port"/>, <paramref name="absPath"/> and <paramref name="secure"/>.
/// </summary>
/// <param name="address">
/// An <see cref="System.Net.IPAddress"/> that contains an IP address.
/// </param>
/// <param name="port">
/// An <see cref="int"/> that contains a port number.
/// </param>
/// <param name="absPath">
/// A <see cref="string"/> that contains an absolute path.
/// </param>
/// <param name="secure">
/// A <see cref="bool"/> that indicates providing a secure connection or not. (<c>true</c> indicates providing a secure connection.)
/// </param>
public WebSocketServiceHost(System.Net.IPAddress address, int port, string absPath, bool secure)
: base(address, port, absPath, secure)
{
@@ -96,6 +181,12 @@ namespace WebSocketSharp.Server {
#region Properties
/// <summary>
/// Gets or sets a value indicating whether the server cleans up the inactive client.
/// </summary>
/// <value>
/// <c>true</c> if the server cleans up the inactive client; otherwise, <c>false</c>.
/// </value>
public bool Sweeped {
get {
return _sessions.Sweeped;
@@ -106,6 +197,12 @@ namespace WebSocketSharp.Server {
}
}
/// <summary>
/// Gets the WebSocket URL on which to listen for incoming connection attempts.
/// </summary>
/// <value>
/// A <see cref="Uri"/> that contains a WebSocket URL.
/// </value>
public Uri Uri {
get {
return BaseUri;
@@ -127,8 +224,31 @@ namespace WebSocketSharp.Server {
#endregion
#region Explicit Interface Implementation
/// <summary>
/// Binds the specified <see cref="WebSocket"/> instance to the WebSocket service.
/// </summary>
/// <param name="socket">
/// A <see cref="WebSocket"/> to bind.
/// </param>
void IServiceHost.BindWebSocket(WebSocket socket)
{
T service = new T();
service.Bind(socket, _sessions);
service.Start();
}
#endregion
#region Protected Method
/// <summary>
/// Accepts the WebSocket connection.
/// </summary>
/// <param name="client">
/// A <see cref="TcpClient"/> that contains the TCP connection.
/// </param>
protected override void AcceptWebSocket(TcpClient client)
{
var context = client.AcceptWebSocket(IsSecure);
@@ -143,30 +263,38 @@ namespace WebSocketSharp.Server {
if (Uri.IsAbsoluteUri)
socket.Url = Uri;
BindWebSocket(socket);
((IServiceHost)this).BindWebSocket(socket);
}
#endregion
#region Public Methods
public void BindWebSocket(WebSocket socket)
{
T service = new T();
service.Bind(socket, _sessions);
service.Start();
}
/// <summary>
/// Broadcasts the specified <see cref="string"/>.
/// </summary>
/// <param name="data">
/// A <see cref="string"/> to broadcast.
/// </param>
public void Broadcast(string data)
{
_sessions.Broadcast(data);
}
/// <summary>
/// Pings with the specified <see cref="string"/> to all clients.
/// </summary>
/// <param name="message">
/// A <see cref="string"/> that contains a message.
/// </param>
public Dictionary<string, bool> Broadping(string message)
{
return _sessions.Broadping(message);
}
/// <summary>
/// Stops receiving the WebSocket connection requests.
/// </summary>
public override void Stop()
{
base.Stop();