aboutsummaryrefslogtreecommitdiff
path: root/SocketHttpListener/WebSocketState.cs
blob: 73b3a49ddc4b84effe9a3ba50b8ce6ef050d55e3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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
  }
}