Refactored HttpServer.cs, WebSocketServer.cs

This commit is contained in:
sta 2014-02-16 17:23:51 +09:00
parent 35b1eef124
commit 9ee09919b1
2 changed files with 122 additions and 168 deletions

View File

@ -48,8 +48,7 @@ using WebSocketSharp.Net.WebSockets;
namespace WebSocketSharp.Server
{
/// <summary>
/// Provides a simple HTTP server that allows to accept the WebSocket
/// connection requests.
/// Provides a simple HTTP server that allows to accept the WebSocket connection requests.
/// </summary>
/// <remarks>
/// The HttpServer class can provide the multi WebSocket services.
@ -58,16 +57,16 @@ namespace WebSocketSharp.Server
{
#region Private Fields
private HttpListener _listener;
private Logger _logger;
private int _port;
private Thread _receiveRequestThread;
private string _rootPath;
private bool _secure;
private WebSocketServiceManager _services;
private volatile ServerState _state;
private object _sync;
private bool _windows;
private HttpListener _listener;
private Logger _logger;
private int _port;
private Thread _receiveRequestThread;
private string _rootPath;
private bool _secure;
private WebSocketServiceManager _services;
private volatile ServerState _state;
private object _sync;
private bool _windows;
#endregion
@ -77,8 +76,7 @@ namespace WebSocketSharp.Server
/// Initializes a new instance of the <see cref="HttpServer"/> class.
/// </summary>
/// <remarks>
/// An instance initialized by this constructor listens for the incoming
/// requests on port 80.
/// An instance initialized by this constructor listens for the incoming requests on port 80.
/// </remarks>
public HttpServer ()
: this (80)
@ -86,17 +84,16 @@ namespace WebSocketSharp.Server
}
/// <summary>
/// Initializes a new instance of the <see cref="HttpServer"/> class with
/// the specified <paramref name="port"/>.
/// Initializes a new instance of the <see cref="HttpServer"/> class with the specified
/// <paramref name="port"/>.
/// </summary>
/// <remarks>
/// <para>
/// An instance initialized by this constructor listens for the incoming
/// requests on <paramref name="port"/>.
/// An instance initialized by this constructor listens for the incoming requests on
/// <paramref name="port"/>.
/// </para>
/// <para>
/// And if <paramref name="port"/> is 443, that instance provides a secure
/// connection.
/// And if <paramref name="port"/> is 443, that instance provides a secure connection.
/// </para>
/// </remarks>
/// <param name="port">
@ -106,24 +103,24 @@ namespace WebSocketSharp.Server
/// <paramref name="port"/> isn't between 1 and 65535.
/// </exception>
public HttpServer (int port)
: this (port, port == 443 ? true : false)
: this (port, port == 443)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="HttpServer"/> class with
/// the specified <paramref name="port"/> and <paramref name="secure"/>.
/// Initializes a new instance of the <see cref="HttpServer"/> class with the specified
/// <paramref name="port"/> and <paramref name="secure"/>.
/// </summary>
/// <remarks>
/// An instance initialized by this constructor listens for the incoming
/// requests on <paramref name="port"/>.
/// An instance initialized by this constructor listens for the incoming requests on
/// <paramref name="port"/>.
/// </remarks>
/// <param name="port">
/// An <see cref="int"/> that represents the port number on which to listen.
/// </param>
/// <param name="secure">
/// A <see cref="bool"/> that indicates providing a secure connection or not.
/// (<c>true</c> indicates providing a secure connection.)
/// A <see cref="bool"/> that indicates providing a secure connection or not. (<c>true</c>
/// indicates providing a secure connection.)
/// </param>
/// <exception cref="ArgumentOutOfRangeException">
/// <paramref name="port"/> isn't between 1 and 65535.
@ -134,13 +131,11 @@ namespace WebSocketSharp.Server
public HttpServer (int port, bool secure)
{
if (!port.IsPortNumber ())
throw new ArgumentOutOfRangeException (
"port", "Must be between 1 and 65535: " + port);
throw new ArgumentOutOfRangeException ("port", "Must be between 1 and 65535: " + port);
if ((port == 80 && secure) || (port == 443 && !secure))
throw new ArgumentException (
String.Format (
"Invalid pair of 'port' and 'secure': {0}, {1}", port, secure));
String.Format ("Invalid pair of 'port' and 'secure': {0}, {1}", port, secure));
_port = port;
_secure = secure;
@ -166,9 +161,9 @@ namespace WebSocketSharp.Server
/// Gets or sets the scheme used to authenticate the clients.
/// </summary>
/// <value>
/// One of the <see cref="WebSocketSharp.Net.AuthenticationSchemes"/> enum
/// values, indicates the scheme used to authenticate the clients. The default
/// value is <see cref="WebSocketSharp.Net.AuthenticationSchemes.Anonymous"/>.
/// One of the <see cref="WebSocketSharp.Net.AuthenticationSchemes"/> enum values, indicates
/// the scheme used to authenticate the clients.
/// The default value is <see cref="WebSocketSharp.Net.AuthenticationSchemes.Anonymous"/>.
/// </value>
public AuthenticationSchemes AuthenticationSchemes {
get {
@ -184,8 +179,7 @@ namespace WebSocketSharp.Server
}
/// <summary>
/// Gets or sets the certificate used to authenticate the server on the
/// secure connection.
/// Gets or sets the certificate used to authenticate the server on the secure connection.
/// </summary>
/// <value>
/// A <see cref="X509Certificate2"/> used to authenticate the server.
@ -200,8 +194,7 @@ namespace WebSocketSharp.Server
return;
if (EndPointListener.CertificateExists (_port, _listener.CertificateFolderPath))
_logger.Warn (
"The server certificate associated with the port number already exists.");
_logger.Warn ("The server certificate associated with the port number already exists.");
_listener.DefaultCertificate = value;
}
@ -223,8 +216,7 @@ namespace WebSocketSharp.Server
/// Gets a value indicating whether the server provides a secure connection.
/// </summary>
/// <value>
/// <c>true</c> if the server provides a secure connection; otherwise,
/// <c>false</c>.
/// <c>true</c> if the server provides a secure connection; otherwise, <c>false</c>.
/// </value>
public bool IsSecure {
get {
@ -233,12 +225,12 @@ namespace WebSocketSharp.Server
}
/// <summary>
/// Gets or sets a value indicating whether the server cleans up the inactive
/// WebSocket sessions periodically.
/// Gets or sets a value indicating whether the server cleans up the inactive sessions in the
/// WebSocket services periodically.
/// </summary>
/// <value>
/// <c>true</c> if the server cleans up the inactive WebSocket sessions every
/// 60 seconds; otherwise, <c>false</c>. The default value is <c>true</c>.
/// <c>true</c> if the server cleans up the inactive sessions every 60 seconds; otherwise,
/// <c>false</c>. The default value is <c>true</c>.
/// </value>
public bool KeepClean {
get {
@ -254,9 +246,9 @@ namespace WebSocketSharp.Server
/// Gets the logging functions.
/// </summary>
/// <remarks>
/// The default logging level is <see cref="LogLevel.ERROR"/>. If you would
/// like to change it, you should set the <c>Log.Level</c> property to any of
/// the <see cref="LogLevel"/> enum values.
/// The default logging level is <see cref="LogLevel.ERROR"/>. If you would like to change it,
/// you should set the <c>Log.Level</c> property to any of the <see cref="LogLevel"/> enum
/// values.
/// </remarks>
/// <value>
/// A <see cref="Logger"/> that provides the logging functions.
@ -280,12 +272,11 @@ namespace WebSocketSharp.Server
}
/// <summary>
/// Gets or sets the name of the realm associated with the
/// <see cref="HttpServer"/>.
/// Gets or sets the name of the realm associated with the server.
/// </summary>
/// <value>
/// A <see cref="string"/> that represents the name of the realm.
/// The default value is <c>SECRET AREA</c>.
/// A <see cref="string"/> that represents the name of the realm. The default value is
/// <c>SECRET AREA</c>.
/// </value>
public string Realm {
get {
@ -301,11 +292,11 @@ namespace WebSocketSharp.Server
}
/// <summary>
/// Gets or sets the document root path of server.
/// Gets or sets the document root path of the server.
/// </summary>
/// <value>
/// A <see cref="string"/> that represents the document root path of server.
/// The default value is <c>./Public</c>.
/// A <see cref="string"/> that represents the document root path of the server. The default
/// value is <c>./Public</c>.
/// </value>
public string RootPath {
get {
@ -323,13 +314,13 @@ namespace WebSocketSharp.Server
}
/// <summary>
/// Gets or sets the delegate called to find the credentials for an identity
/// used to authenticate a client.
/// Gets or sets the delegate called to find the credentials for an identity used to
/// authenticate a client.
/// </summary>
/// <value>
/// A Func&lt;<see cref="IIdentity"/>, <see cref="NetworkCredential"/>&gt;
/// delegate that references the method(s) used to find the credentials.
/// The default value is a function that only returns <see langword="null"/>.
/// A Func&lt;<see cref="IIdentity"/>, <see cref="NetworkCredential"/>&gt; delegate that
/// references the method(s) used to find the credentials. The default value is a function
/// that only returns <see langword="null"/>.
/// </value>
public Func<IIdentity, NetworkCredential> UserCredentialsFinder {
get {
@ -345,7 +336,7 @@ namespace WebSocketSharp.Server
}
/// <summary>
/// Gets the access to the WebSocket services provided by the <see cref="HttpServer"/>.
/// Gets the access to the WebSocket services provided by the server.
/// </summary>
/// <value>
/// A <see cref="WebSocketServiceManager"/> that manages the WebSocket services.
@ -419,10 +410,9 @@ namespace WebSocketSharp.Server
}
_services.Stop (
((ushort) CloseStatusCode.SERVER_ERROR).ToByteArrayInternally (ByteOrder.BIG),
true);
_listener.Abort ();
((ushort) CloseStatusCode.SERVER_ERROR).ToByteArrayInternally (ByteOrder.BIG), true);
_listener.Abort ();
_state = ServerState.STOP;
}
@ -430,7 +420,6 @@ namespace WebSocketSharp.Server
{
var args = new HttpRequestEventArgs (context);
var method = context.Request.HttpMethod;
if (method == "GET") {
if (OnGet != null) {
OnGet (this, args);
@ -519,8 +508,7 @@ namespace WebSocketSharp.Server
var path = context.Path;
WebSocketServiceHost host;
if (path == null ||
!_services.TryGetServiceHostInternally (path, out host)) {
if (path == null || !_services.TryGetServiceHostInternally (path, out host)) {
context.Close (HttpStatusCode.NotImplemented);
return;
}
@ -528,8 +516,7 @@ namespace WebSocketSharp.Server
host.StartSession (context);
}
private bool authenticateRequest (
AuthenticationSchemes scheme, HttpListenerContext context)
private bool authenticateRequest (AuthenticationSchemes scheme, HttpListenerContext context)
{
if (context.Request.IsAuthenticated)
return true;
@ -551,7 +538,7 @@ namespace WebSocketSharp.Server
if (_state == ServerState.START || _state == ServerState.SHUTDOWN) {
_logger.Error (
String.Format (
"The '{0}' property cannot set a value because the server has already been started.",
"Set operation of {0} isn't available because the server has already started.",
property));
return false;
@ -576,10 +563,7 @@ namespace WebSocketSharp.Server
acceptRequestAsync (_listener.GetContext ());
}
catch (HttpListenerException ex) {
_logger.Warn (
String.Format (
"Receiving has been stopped.\nreason: {0}.", ex.Message));
_logger.Warn ("Receiving has been stopped.\nreason: " + ex.Message);
break;
}
catch (Exception ex) {
@ -610,74 +594,64 @@ namespace WebSocketSharp.Server
#region Public Methods
/// <summary>
/// Adds the specified typed WebSocket service with the specified
/// <paramref name="servicePath"/>.
/// Adds the specified typed WebSocket service with the specified <paramref name="path"/>.
/// </summary>
/// <remarks>
/// This method converts <paramref name="servicePath"/> to URL-decoded string
/// and removes <c>'/'</c> from tail end of <paramref name="servicePath"/>.
/// This method converts <paramref name="path"/> to URL-decoded string and removes <c>'/'</c>
/// from tail end of <paramref name="path"/>.
/// </remarks>
/// <param name="servicePath">
/// A <see cref="string"/> that represents the absolute path to the WebSocket
/// service.
/// <param name="path">
/// A <see cref="string"/> that represents the absolute path to the WebSocket service to add.
/// </param>
/// <typeparam name="TWithNew">
/// The type of the WebSocket service. The TWithNew must inherit the
/// <see cref="WebSocketService"/> class and must have a public parameterless
/// constructor.
/// The type of the WebSocket service.
/// The TWithNew must inherit the <see cref="WebSocketService"/> class and must have a public
/// parameterless constructor.
/// </typeparam>
public void AddWebSocketService<TWithNew> (string servicePath)
public void AddWebSocketService<TWithNew> (string path)
where TWithNew : WebSocketService, new ()
{
AddWebSocketService<TWithNew> (servicePath, () => new TWithNew ());
AddWebSocketService<TWithNew> (path, () => new TWithNew ());
}
/// <summary>
/// Adds the specified typed WebSocket service with the specified
/// <paramref name="servicePath"/> and <paramref name="serviceConstructor"/>.
/// Adds the specified typed WebSocket service with the specified <paramref name="path"/> and
/// <paramref name="constructor"/>.
/// </summary>
/// <remarks>
/// <para>
/// This method converts <paramref name="servicePath"/> to URL-decoded
/// string and removes <c>'/'</c> from tail end of
/// <paramref name="servicePath"/>.
/// This method converts <paramref name="path"/> to URL-decoded string and removes <c>'/'</c>
/// from tail end of <paramref name="path"/>.
/// </para>
/// <para>
/// <paramref name="serviceConstructor"/> returns a initialized specified
/// typed WebSocket service instance.
/// <paramref name="constructor"/> returns a initialized specified typed
/// <see cref="WebSocketService"/> instance.
/// </para>
/// </remarks>
/// <param name="servicePath">
/// A <see cref="string"/> that represents the absolute path to the WebSocket
/// service.
/// <param name="path">
/// A <see cref="string"/> that represents the absolute path to the WebSocket service to add.
/// </param>
/// <param name="serviceConstructor">
/// A Func&lt;T&gt; delegate that references the method used to initialize
/// a new WebSocket service instance (a new WebSocket session).
/// <param name="constructor">
/// A Func&lt;T&gt; delegate that references the method used to initialize a new specified
/// typed <see cref="WebSocketService"/> instance (a new <see cref="IWebSocketSession"/>
/// instance).
/// </param>
/// <typeparam name="T">
/// The type of the WebSocket service. The T must inherit the
/// <see cref="WebSocketService"/> class.
/// The type of the WebSocket service. The T must inherit the <see cref="WebSocketService"/>
/// class.
/// </typeparam>
public void AddWebSocketService<T> (
string servicePath, Func<T> serviceConstructor)
public void AddWebSocketService<T> (string path, Func<T> constructor)
where T : WebSocketService
{
var msg = servicePath.CheckIfValidServicePath () ??
(serviceConstructor == null
? "'serviceConstructor' must not be null."
: null);
var msg = path.CheckIfValidServicePath () ??
(constructor == null ? "'constructor' must not be null." : null);
if (msg != null) {
_logger.Error (
String.Format ("{0}\nservice path: {1}", msg, servicePath ?? ""));
_logger.Error (String.Format ("{0}\nservice path: {1}", msg, path));
return;
}
var host = new WebSocketServiceHost<T> (
servicePath, serviceConstructor, _logger);
var host = new WebSocketServiceHost<T> (path, constructor, _logger);
if (!KeepClean)
host.KeepClean = false;
@ -688,12 +662,11 @@ namespace WebSocketSharp.Server
/// Gets the contents of the file with the specified <paramref name="path"/>.
/// </summary>
/// <returns>
/// An array of <see cref="byte"/> that receives the contents of the file if
/// it exists; otherwise, <see langword="null"/>.
/// An array of <see cref="byte"/> that receives the contents of the file if it exists;
/// otherwise, <see langword="null"/>.
/// </returns>
/// <param name="path">
/// A <see cref="string"/> that represents the virtual path to the file
/// to get.
/// A <see cref="string"/> that represents the virtual path to the file to find.
/// </param>
public byte [] GetFile (string path)
{
@ -707,31 +680,28 @@ namespace WebSocketSharp.Server
}
/// <summary>
/// Removes the WebSocket service with the specified <paramref name="servicePath"/>.
/// Removes the WebSocket service with the specified <paramref name="path"/>.
/// </summary>
/// <remarks>
/// This method converts <paramref name="servicePath"/> to URL-decoded string
/// and removes <c>'/'</c> from tail end of <paramref name="servicePath"/>.
/// This method converts <paramref name="path"/> to URL-decoded string and removes <c>'/'</c>
/// from tail end of <paramref name="path"/>.
/// </remarks>
/// <returns>
/// <c>true</c> if the WebSocket service is successfully found and removed;
/// otherwise, <c>false</c>.
/// <c>true</c> if the WebSocket service is successfully found and removed; otherwise,
/// <c>false</c>.
/// </returns>
/// <param name="servicePath">
/// A <see cref="string"/> that represents the absolute path to the WebSocket
/// service to find.
/// <param name="path">
/// A <see cref="string"/> that represents the absolute path to the WebSocket service to find.
/// </param>
public bool RemoveWebSocketService (string servicePath)
public bool RemoveWebSocketService (string path)
{
var msg = servicePath.CheckIfValidServicePath ();
var msg = path.CheckIfValidServicePath ();
if (msg != null) {
_logger.Error (
String.Format ("{0}\nservice path: {1}", msg, servicePath));
_logger.Error (String.Format ("{0}\nservice path: {1}", msg, path));
return false;
}
return _services.Remove (servicePath);
return _services.Remove (path);
}
/// <summary>
@ -742,10 +712,7 @@ namespace WebSocketSharp.Server
lock (_sync) {
var msg = _state.CheckIfStartable () ?? checkIfCertExists ();
if (msg != null) {
_logger.Error (
String.Format (
"{0}\nstate: {1}\nsecure: {2}", msg, _state, _secure));
_logger.Error (String.Format ("{0}\nstate: {1}\nsecure: {2}", msg, _state, _secure));
return;
}
@ -779,12 +746,11 @@ namespace WebSocketSharp.Server
}
/// <summary>
/// Stops receiving the HTTP requests with the specified <see cref="ushort"/>
/// and <see cref="string"/> used to stop the WebSocket services.
/// Stops receiving the HTTP requests with the specified <see cref="ushort"/> and
/// <see cref="string"/> used to stop the WebSocket services.
/// </summary>
/// <param name="code">
/// A <see cref="ushort"/> that represents the status code indicating the
/// reason for stop.
/// A <see cref="ushort"/> that represents the status code indicating the reason for stop.
/// </param>
/// <param name="reason">
/// A <see cref="string"/> that represents the reason for stop.
@ -799,8 +765,7 @@ namespace WebSocketSharp.Server
if (msg != null) {
_logger.Error (
String.Format (
"{0}\nstate: {1}\ncode: {2}\nreason: {3}", msg, _state, code, reason));
String.Format ("{0}\nstate: {1}\ncode: {2}\nreason: {3}", msg, _state, code, reason));
return;
}
@ -815,12 +780,12 @@ namespace WebSocketSharp.Server
}
/// <summary>
/// Stops receiving the HTTP requests with the specified <see cref="CloseStatusCode"/>
/// and <see cref="string"/> used to stop the WebSocket services.
/// Stops receiving the HTTP requests with the specified <see cref="CloseStatusCode"/> and
/// <see cref="string"/> used to stop the WebSocket services.
/// </summary>
/// <param name="code">
/// One of the <see cref="CloseStatusCode"/> enum values, represents the
/// status code indicating the reasons for stop.
/// One of the <see cref="CloseStatusCode"/> enum values, represents the status code indicating
/// the reasons for stop.
/// </param>
/// <param name="reason">
/// A <see cref="string"/> that represents the reason for stop.
@ -833,9 +798,7 @@ namespace WebSocketSharp.Server
(data = ((ushort) code).Append (reason)).CheckIfValidControlData ("reason");
if (msg != null) {
_logger.Error (
String.Format ("{0}\nstate: {1}\nreason: {2}", msg, _state, reason));
_logger.Error (String.Format ("{0}\nstate: {1}\nreason: {2}", msg, _state, reason));
return;
}

View File

@ -148,11 +148,10 @@ namespace WebSocketSharp.Server
var host = _uri.DnsSafeHost;
_address = host.ToIPAddress ();
if (_address == null || !_address.IsLocal ())
throw new ArgumentException (
String.Format ("The host part must be the local host name: {0}", host), "url");
throw new ArgumentException ("The host part must be the local host name: " + host, "url");
_port = _uri.Port;
_secure = _uri.Scheme == "wss" ? true : false;
_secure = _uri.Scheme == "wss";
init ();
}
@ -212,7 +211,7 @@ namespace WebSocketSharp.Server
/// <paramref name="address"/> isn't a local IP address.
/// </exception>
public WebSocketServer (System.Net.IPAddress address, int port)
: this (address, port, port == 443 ? true : false)
: this (address, port, port == 443)
{
}
@ -254,8 +253,7 @@ namespace WebSocketSharp.Server
public WebSocketServer (System.Net.IPAddress address, int port, bool secure)
{
if (!address.IsLocal ())
throw new ArgumentException (
String.Format ("Must be the local IP address: {0}", address), "address");
throw new ArgumentException ("Must be the local IP address: " + address, "address");
if (!port.IsPortNumber ())
throw new ArgumentOutOfRangeException ("port", "Must be between 1 and 65535: " + port);
@ -344,8 +342,7 @@ namespace WebSocketSharp.Server
/// Gets a value indicating whether the server provides a secure connection.
/// </summary>
/// <value>
/// <c>true</c> if the server provides a secure connection; otherwise,
/// <c>false</c>.
/// <c>true</c> if the server provides a secure connection; otherwise, <c>false</c>.
/// </value>
public bool IsSecure {
get {
@ -469,8 +466,7 @@ namespace WebSocketSharp.Server
_listener.Stop ();
_services.Stop (
((ushort) CloseStatusCode.SERVER_ERROR).ToByteArrayInternally (ByteOrder.BIG),
true);
((ushort) CloseStatusCode.SERVER_ERROR).ToByteArrayInternally (ByteOrder.BIG), true);
_state = ServerState.STOP;
}
@ -511,11 +507,11 @@ namespace WebSocketSharp.Server
}
private bool authenticateRequest (
AuthenticationSchemes authScheme, TcpListenerWebSocketContext context)
AuthenticationSchemes scheme, TcpListenerWebSocketContext context)
{
var challenge = authScheme == AuthenticationSchemes.Basic
var challenge = scheme == AuthenticationSchemes.Basic
? HttpUtility.CreateBasicAuthChallenge (Realm)
: authScheme == AuthenticationSchemes.Digest
: scheme == AuthenticationSchemes.Digest
? HttpUtility.CreateDigestAuthChallenge (Realm)
: null;
@ -525,7 +521,7 @@ namespace WebSocketSharp.Server
}
var retry = -1;
var expected = authScheme.ToString ();
var expected = scheme.ToString ();
var realm = Realm;
var credentialsFinder = UserCredentialsFinder;
Func<bool> auth = null;
@ -542,7 +538,7 @@ namespace WebSocketSharp.Server
return auth ();
}
context.SetUser (authScheme, realm, credentialsFinder);
context.SetUser (scheme, realm, credentialsFinder);
if (context.IsAuthenticated)
return true;
@ -591,8 +587,7 @@ namespace WebSocketSharp.Server
acceptRequestAsync (_listener.AcceptTcpClient ());
}
catch (SocketException ex) {
_logger.Warn (String.Format ("Receiving has been stopped.\nreason: {0}.", ex.Message));
_logger.Warn ("Receiving has been stopped.\nreason: " + ex.Message);
break;
}
catch (Exception ex) {
@ -692,7 +687,6 @@ namespace WebSocketSharp.Server
if (msg != null) {
_logger.Error (String.Format ("{0}\nservice path: {1}", msg, path));
return;
}
@ -722,7 +716,6 @@ namespace WebSocketSharp.Server
var msg = path.CheckIfValidServicePath ();
if (msg != null) {
_logger.Error (String.Format ("{0}\nservice path: {1}", msg, path));
return false;
}
@ -738,7 +731,6 @@ namespace WebSocketSharp.Server
var msg = _state.CheckIfStartable () ?? checkIfCertExists ();
if (msg != null) {
_logger.Error (String.Format ("{0}\nstate: {1}\nsecure: {2}", msg, _state, _secure));
return;
}
@ -825,7 +817,6 @@ namespace WebSocketSharp.Server
if (msg != null) {
_logger.Error (String.Format ("{0}\nstate: {1}\nreason: {2}", msg, _state, reason));
return;
}