aboutsummaryrefslogtreecommitdiff
path: root/SocketHttpListener/CloseStatusCode.cs
blob: 428595bb09a8764c04474d1ca080fa2efa54a2c1 (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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
namespace SocketHttpListener
{
    /// <summary>
    /// Contains the values of the status code for the WebSocket connection close.
    /// </summary>
    /// <remarks>
    ///   <para>
    ///   The values of the status code are defined in
    ///   <see href="http://tools.ietf.org/html/rfc6455#section-7.4">Section 7.4</see>
    ///   of RFC 6455.
    ///   </para>
    ///   <para>
    ///   "Reserved value" must not be set as a status code in a close control frame
    ///   by an endpoint. It's designated for use in applications expecting a status
    ///   code to indicate that the connection was closed due to the system grounds.
    ///   </para>
    /// </remarks>
    public enum CloseStatusCode : ushort
    {
        /// <summary>
        /// Equivalent to close status 1000.
        /// Indicates a normal close.
        /// </summary>
        Normal = 1000,
        /// <summary>
        /// Equivalent to close status 1001.
        /// Indicates that an endpoint is going away.
        /// </summary>
        Away = 1001,
        /// <summary>
        /// Equivalent to close status 1002.
        /// Indicates that an endpoint is terminating the connection due to a protocol error.
        /// </summary>
        ProtocolError = 1002,
        /// <summary>
        /// Equivalent to close status 1003.
        /// Indicates that an endpoint is terminating the connection because it has received
        /// an unacceptable type message.
        /// </summary>
        IncorrectData = 1003,
        /// <summary>
        /// Equivalent to close status 1004.
        /// Still undefined. Reserved value.
        /// </summary>
        Undefined = 1004,
        /// <summary>
        /// Equivalent to close status 1005.
        /// Indicates that no status code was actually present. Reserved value.
        /// </summary>
        NoStatusCode = 1005,
        /// <summary>
        /// Equivalent to close status 1006.
        /// Indicates that the connection was closed abnormally. Reserved value.
        /// </summary>
        Abnormal = 1006,
        /// <summary>
        /// Equivalent to close status 1007.
        /// Indicates that an endpoint is terminating the connection because it has received
        /// a message that contains a data that isn't consistent with the type of the message.
        /// </summary>
        InconsistentData = 1007,
        /// <summary>
        /// Equivalent to close status 1008.
        /// Indicates that an endpoint is terminating the connection because it has received
        /// a message that violates its policy.
        /// </summary>
        PolicyViolation = 1008,
        /// <summary>
        /// Equivalent to close status 1009.
        /// Indicates that an endpoint is terminating the connection because it has received
        /// a message that is too big to process.
        /// </summary>
        TooBig = 1009,
        /// <summary>
        /// Equivalent to close status 1010.
        /// Indicates that the client is terminating the connection because it has expected
        /// the server to negotiate one or more extension, but the server didn't return them
        /// in the handshake response.
        /// </summary>
        IgnoreExtension = 1010,
        /// <summary>
        /// Equivalent to close status 1011.
        /// Indicates that the server is terminating the connection because it has encountered
        /// an unexpected condition that prevented it from fulfilling the request.
        /// </summary>
        ServerError = 1011,
        /// <summary>
        /// Equivalent to close status 1015.
        /// Indicates that the connection was closed due to a failure to perform a TLS handshake.
        /// Reserved value.
        /// </summary>
        TlsHandshakeFailure = 1015
    }
}