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

Added some XML documentation comments and renamed some method names

Browse Source
This commit is contained in:
sta
2013-02-11 22:57:01 +09:00
parent afe74fe857
commit 9b1772e80a
89 changed files with 1957 additions and 624 deletions
Download Patch File Download Diff File Expand all files Collapse all files

241
websocket-sharp/Server/HttpServer.cs
View File

@@ -36,14 +36,35 @@ using WebSocketSharp.Net;
namespace WebSocketSharp.Server {
/// <summary>
/// Provides the functions of a simple HTTP server that allows to accept the WebSocket connection requests.
/// </summary>
/// <remarks>
/// <para>
/// The HttpServer class provides the multi WebSocket service.
/// </para>
/// <para>
/// <para>
/// The HttpServer class needs the application configuration file to configure the server root path.
/// </para>
/// <code lang="xml">
/// &lt;?xml version="1.0" encoding="utf-8"?&gt;
/// &lt;configuration&gt;
/// &lt;appSettings&gt;
/// &lt;add key="RootPath" value="./Public" /&gt;
/// &lt;/appSettings&gt;
/// &lt;/configuration&gt;
/// </code>
/// </para>
/// </remarks>
public class HttpServer {
#region Fields
private Thread _acceptRequestThread;
private bool _isWindows;
private HttpListener _listener;
private int _port;
private Thread _receiveRequestThread;
private string _rootPath;
private ServiceHostManager _svcHosts;
@@ -51,11 +72,22 @@ namespace WebSocketSharp.Server {
#region Constructors
/// <summary>
/// Initializes a new instance of the <see cref="HttpServer"/> class that listens for incoming requests
/// on port 80.
/// </summary>
public HttpServer()
: this(80)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="HttpServer"/> class that listens for incoming requests
/// on the specified <paramref name="port"/>.
/// </summary>
/// <param name="port">
/// An <see cref="int"/> that contains a port number.
/// </param>
public HttpServer(int port)
{
_port = port;
@@ -66,16 +98,35 @@ namespace WebSocketSharp.Server {
#region Properties
/// <summary>
/// Gets the port on which to listen for incoming requests.
/// </summary>
/// <value>
/// An <see cref="int"/> that contains a port number.
/// </value>
public int Port {
get { return _port; }
}
/// <summary>
/// Gets the collection of paths associated with the every WebSocket services that the server provides.
/// </summary>
/// <value>
/// An IEnumerable&lt;string&gt; that contains the collection of paths.
/// </value>
public IEnumerable<string> ServicePaths {
get {
return _svcHosts.Paths;
}
}
/// <summary>
/// Gets or sets a value indicating whether the server cleans up the inactive WebSocket service instances periodically.
/// </summary>
/// <value>
/// <c>true</c> if the server cleans up the inactive WebSocket service instances every 60 seconds;
/// otherwise, <c>false</c>. The default value is <c>true</c>.
/// </value>
public bool Sweeped {
get {
return _svcHosts.Sweeped;
@@ -90,43 +141,60 @@ namespace WebSocketSharp.Server {
#region Events
public event EventHandler<ResponseEventArgs> OnConnect;
public event EventHandler<ResponseEventArgs> OnDelete;
public event EventHandler<ErrorEventArgs> OnError;
public event EventHandler<ResponseEventArgs> OnGet;
public event EventHandler<ResponseEventArgs> OnHead;
public event EventHandler<ResponseEventArgs> OnOptions;
public event EventHandler<ResponseEventArgs> OnPatch;
public event EventHandler<ResponseEventArgs> OnPost;
public event EventHandler<ResponseEventArgs> OnPut;
public event EventHandler<ResponseEventArgs> OnTrace;
/// <summary>
/// Occurs when the server gets an error.
/// </summary>
public event EventHandler<ErrorEventArgs> OnError;
/// <summary>
/// Occurs when the server receives an HTTP CONNECT request.
/// </summary>
public event EventHandler<ResponseEventArgs> OnResponseToConnect;
/// <summary>
/// Occurs when the server receives an HTTP DELETE request.
/// </summary>
public event EventHandler<ResponseEventArgs> OnResponseToDelete;
/// <summary>
/// Occurs when the server receives an HTTP GET request.
/// </summary>
public event EventHandler<ResponseEventArgs> OnResponseToGet;
/// <summary>
/// Occurs when the server receives an HTTP HEAD request.
/// </summary>
public event EventHandler<ResponseEventArgs> OnResponseToHead;
/// <summary>
/// Occurs when the server receives an HTTP OPTIONS request.
/// </summary>
public event EventHandler<ResponseEventArgs> OnResponseToOptions;
/// <summary>
/// Occurs when the server receives an HTTP PATCH request.
/// </summary>
public event EventHandler<ResponseEventArgs> OnResponseToPatch;
/// <summary>
/// Occurs when the server receives an HTTP POST request.
/// </summary>
public event EventHandler<ResponseEventArgs> OnResponseToPost;
/// <summary>
/// Occurs when the server receives an HTTP PUT request.
/// </summary>
public event EventHandler<ResponseEventArgs> OnResponseToPut;
/// <summary>
/// Occurs when the server receives an HTTP TRACE request.
/// </summary>
public event EventHandler<ResponseEventArgs> OnResponseToTrace;
#endregion
#region Private Methods
private void acceptRequest()
{
while (true)
{
try
{
var context = _listener.GetContext();
respondAsync(context);
}
catch (HttpListenerException)
{
// HttpListener has been closed.
break;
}
catch (Exception ex)
{
onError(ex.Message);
break;
}
}
}
private void configureFromConfigFile()
{
_rootPath = ConfigurationManager.AppSettings["RootPath"];
@@ -170,63 +238,85 @@ namespace WebSocketSharp.Server {
OnError.Emit(this, new ErrorEventArgs(message));
}
private void receiveRequest()
{
while (true)
{
try
{
var context = _listener.GetContext();
respondAsync(context);
}
catch (HttpListenerException)
{
// HttpListener has been closed.
break;
}
catch (Exception ex)
{
onError(ex.Message);
break;
}
}
}
private void respond(HttpListenerContext context)
{
var req = context.Request;
var res = context.Response;
var eventArgs = new ResponseEventArgs(context);
if (req.HttpMethod == "GET" && OnGet != null)
if (req.HttpMethod == "GET" && !OnResponseToGet.IsNull())
{
OnGet(this, eventArgs);
OnResponseToGet(this, eventArgs);
return;
}
if (req.HttpMethod == "HEAD" && OnHead != null)
if (req.HttpMethod == "HEAD" && !OnResponseToHead.IsNull())
{
OnHead(this, eventArgs);
OnResponseToHead(this, eventArgs);
return;
}
if (req.HttpMethod == "POST" && OnPost != null)
if (req.HttpMethod == "POST" && !OnResponseToPost.IsNull())
{
OnPost(this, eventArgs);
OnResponseToPost(this, eventArgs);
return;
}
if (req.HttpMethod == "PUT" && OnPut != null)
if (req.HttpMethod == "PUT" && !OnResponseToPut.IsNull())
{
OnPut(this, eventArgs);
OnResponseToPut(this, eventArgs);
return;
}
if (req.HttpMethod == "DELETE" && OnDelete != null)
if (req.HttpMethod == "DELETE" && !OnResponseToDelete.IsNull())
{
OnDelete(this, eventArgs);
OnResponseToDelete(this, eventArgs);
return;
}
if (req.HttpMethod == "OPTIONS" && OnOptions != null)
if (req.HttpMethod == "OPTIONS" && !OnResponseToOptions.IsNull())
{
OnOptions(this, eventArgs);
OnResponseToOptions(this, eventArgs);
return;
}
if (req.HttpMethod == "TRACE" && OnTrace != null)
if (req.HttpMethod == "TRACE" && !OnResponseToTrace.IsNull())
{
OnTrace(this, eventArgs);
OnResponseToTrace(this, eventArgs);
return;
}
if (req.HttpMethod == "CONNECT" && OnConnect != null)
if (req.HttpMethod == "CONNECT" && !OnResponseToConnect.IsNull())
{
OnConnect(this, eventArgs);
OnResponseToConnect(this, eventArgs);
return;
}
if (req.HttpMethod == "PATCH" && OnPatch != null)
if (req.HttpMethod == "PATCH" && !OnResponseToPatch.IsNull())
{
OnPatch(this, eventArgs);
OnResponseToPatch(this, eventArgs);
return;
}
@@ -235,7 +325,7 @@ namespace WebSocketSharp.Server {
private void respondAsync(HttpListenerContext context)
{
WaitCallback respondCb = (state) =>
WaitCallback callback = (state) =>
{
var req = context.Request;
var res = context.Response;
@@ -260,14 +350,14 @@ namespace WebSocketSharp.Server {
}
};
ThreadPool.QueueUserWorkItem(respondCb);
ThreadPool.QueueUserWorkItem(callback);
}
private void startAcceptRequestThread()
private void startReceiveRequestThread()
{
_acceptRequestThread = new Thread(new ThreadStart(acceptRequest));
_acceptRequestThread.IsBackground = true;
_acceptRequestThread.Start();
_receiveRequestThread = new Thread(new ThreadStart(receiveRequest));
_receiveRequestThread.IsBackground = true;
_receiveRequestThread.Start();
}
private bool upgradeToWebSocket(HttpListenerContext context)
@@ -292,7 +382,16 @@ namespace WebSocketSharp.Server {
#region Public Methods
public void AddService<T>(string absPath)
/// <summary>
/// Adds the specified type 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 AddWebSocketService<T>(string absPath)
where T : WebSocketService, new()
{
string msg;
@@ -310,28 +409,42 @@ namespace WebSocketSharp.Server {
_svcHosts.Add(absPath, svcHost);
}
/// <summary>
/// Gets the contents of the specified file.
/// </summary>
/// <returns>
/// An array of <see cref="byte"/> that contains the contents of the file.
/// </returns>
/// <param name="path">
/// A <see cref="string"/> that contains a virtual path to the file to get.
/// </param>
public byte[] GetFile(string path)
{
var filePath = _rootPath + path;
if (_isWindows)
filePath = filePath.Replace("/", "\\");
if (File.Exists(filePath))
return File.ReadAllBytes(filePath);
return null;
return File.Exists(filePath)
? File.ReadAllBytes(filePath)
: null;
}
/// <summary>
/// Starts to receive incoming requests.
/// </summary>
public void Start()
{
_listener.Start();
startAcceptRequestThread();
startReceiveRequestThread();
}
/// <summary>
/// Stops receiving incoming requests.
/// </summary>
public void Stop()
{
_listener.Close();
_acceptRequestThread.Join(5 * 1000);
_receiveRequestThread.Join(5 * 1000);
_svcHosts.Stop();
}

37
websocket-sharp/Server/ResponseEventArgs.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
@@ -31,15 +31,44 @@ using WebSocketSharp.Net;
namespace WebSocketSharp.Server {
/// <summary>
/// Contains the event data associated with the response events of the <see cref="HttpServer"/> class.
/// </summary>
/// <remarks>
/// A response event occurs when a <see cref="HttpServer"/> instance receives an HTTP request.
/// If you want to get the HTTP request objects, you should access the <see cref="ResponseEventArgs.Request"/> property.
/// If you want to get the HTTP response objects to send, you should access the <see cref="ResponseEventArgs.Response"/> property.
/// </remarks>
public class ResponseEventArgs : EventArgs
{
public HttpListenerRequest Request { get; private set; }
public HttpListenerResponse Response { get; private set; }
#region Constructor
public ResponseEventArgs(HttpListenerContext context)
internal ResponseEventArgs(HttpListenerContext context)
{
Request = context.Request;
Response = context.Response;
}
#endregion
#region Properties
/// <summary>
/// Gets the HTTP request objects sent from a client.
/// </summary>
/// <value>
/// A <see cref="HttpListenerRequest"/> that contains the HTTP request objects.
/// </value>
public HttpListenerRequest Request { get; private set; }
/// <summary>
/// Gets the HTTP response objects to send to the client in response to the client's request.
/// </summary>
/// <value>
/// A <see cref="HttpListenerResponse"/> that contains the HTTP response objects.
/// </value>
public HttpListenerResponse Response { get; private set; }
#endregion
}
}

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

@@ -165,6 +165,7 @@ namespace WebSocketSharp.Server {
/// </summary>
/// <value>
/// <c>true</c> if the server cleans up the inactive clients every 60 seconds; otherwise, <c>false</c>.
/// The default value is <c>true</c>.
/// </value>
public bool Sweeped {
get {
@@ -218,7 +219,7 @@ namespace WebSocketSharp.Server {
#region Public Methods
/// <summary>
/// Adds a WebSocket service.
/// Adds the specified type WebSocket service.
/// </summary>
/// <param name="absPath">
/// A <see cref="string"/> that contains an absolute path associated with the WebSocket service.
@@ -226,7 +227,7 @@ namespace WebSocketSharp.Server {
/// <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)
public void AddWebSocketService<T>(string absPath)
where T : WebSocketService, new()
{
string msg;

2
websocket-sharp/Server/WebSocketServerBase.cs
View File

@@ -229,7 +229,7 @@ namespace WebSocketSharp.Server {
#region Event
/// <summary>
/// Occurs when this server gets an error.
/// Occurs when the server gets an error.
/// </summary>
public event EventHandler<ErrorEventArgs> OnError;

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

@@ -187,6 +187,7 @@ namespace WebSocketSharp.Server {
/// </summary>
/// <value>
/// <c>true</c> if the server cleans up the inactive clients every 60 seconds; otherwise, <c>false</c>.
/// The default value is <c>true</c>.
/// </value>
public bool Sweeped {
get {