websocket-sharp/websocket-sharp/CloseEventArgs.cs
2014-01-09 14:58:19 +09:00

131 lines
3.4 KiB
C#

#region License
/*
* CloseEventArgs.cs
*
* The MIT License
*
* Copyright (c) 2012-2014 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.Text;
namespace WebSocketSharp
{
/// <summary>
/// Contains the event data associated with a <see cref="WebSocket.OnClose"/>
/// event.
/// </summary>
/// <remarks>
/// A <see cref="WebSocket.OnClose"/> event occurs when the WebSocket connection
/// has been closed. If you want to get the reason for closure, you access the
/// <see cref="Code"/> or <see cref="Reason"/> property.
/// </remarks>
public class CloseEventArgs : EventArgs
{
#region Private Fields
private bool _clean;
private ushort _code;
private string _reason;
#endregion
#region Internal Constructors
internal CloseEventArgs (PayloadData payload)
{
var data = payload.ApplicationData;
_code = getCodeFrom (data);
_reason = getReasonFrom (data);
_clean = false;
}
#endregion
#region Public Properties
/// <summary>
/// Gets the status code for closure.
/// </summary>
/// <value>
/// A <see cref="ushort"/> that indicates the status code for closure if any.
/// </value>
public ushort Code {
get {
return _code;
}
}
/// <summary>
/// Gets the reason for closure.
/// </summary>
/// <value>
/// A <see cref="string"/> that represents the reason for closure if any.
/// </value>
public string Reason {
get {
return _reason;
}
}
/// <summary>
/// Gets a value indicating whether the WebSocket connection has been closed
/// cleanly.
/// </summary>
/// <value>
/// <c>true</c> if the WebSocket connection has been closed cleanly;
/// otherwise, <c>false</c>.
/// </value>
public bool WasClean {
get {
return _clean;
}
internal set {
_clean = value;
}
}
#endregion
#region Private Methods
private static ushort getCodeFrom (byte [] data)
{
return data.Length > 1
? data.SubArray (0, 2).ToUInt16 (ByteOrder.BIG)
: (ushort) CloseStatusCode.NO_STATUS_CODE;
}
private static string getReasonFrom (byte [] data)
{
var len = data.Length;
return len > 2
? Encoding.UTF8.GetString (data.SubArray (2, len - 2))
: String.Empty;
}
#endregion
}
}