jellyfin/SocketHttpListener.Portable/WebSocketState.cs
2016-11-11 14:55:12 -05:00

36 lines
1.1 KiB
C#

namespace SocketHttpListener
{
/// <summary>
/// Contains the values of the state of the WebSocket connection.
/// </summary>
/// <remarks>
/// The values of the state are defined in
/// <see href="http://www.w3.org/TR/websockets/#dom-websocket-readystate">The WebSocket
/// API</see>.
/// </remarks>
public enum WebSocketState : 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 the communication is possible.
/// </summary>
Open = 1,
/// <summary>
/// Equivalent to numeric value 2.
/// Indicates that the connection is going through the closing handshake or
/// the <c>WebSocket.Close</c> method has been invoked.
/// </summary>
Closing = 2,
/// <summary>
/// Equivalent to numeric value 3.
/// Indicates that the connection has been closed or couldn't be opened.
/// </summary>
Closed = 3
}
}