websocket-sharp/websocket-sharp/WsState.cs
2013-05-07 02:19:31 +09:00

60 lines
2.3 KiB
C#

#region License
/*
* WsState.cs
*
* The MIT License
*
* Copyright (c) 2010-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;
namespace WebSocketSharp {
/// <summary>
/// Contains the values of the state of the WebSocket connection.
/// </summary>
/// <remarks>
/// The <b>WsState</b> enumeration contains the values of the state of the WebSocket connection defined in
/// <a href="http://www.w3.org/TR/websockets/#dom-websocket-readystate">The WebSocket API</a>.
/// </remarks>
public enum WsState : ushort
{
/// <summary>
/// Equivalent to numeric value 0. Indicates that the connection has not yet been established.
/// </summary>
CONNECTING = 0,
/// <summary>
/// Equivalent to numeric value 1. Indicates that the connection is established and communication is possible.
/// </summary>
OPEN = 1,
/// <summary>
/// Equivalent to numeric value 2. Indicates that the connection is going through the closing handshake, or the <b>Close</b> method has been invoked.
/// </summary>
CLOSING = 2,
/// <summary>
/// Equivalent to numeric value 3. Indicates that the connection has been closed or could not be opened.
/// </summary>
CLOSED = 3
}
}