aboutsummaryrefslogtreecommitdiffstats
path: root/pages/develop/api/efl/net/dialer/websocket/close_reason.txt
blob: 500fc6731dd152fa9d795123690c6df9db06aa9b (plain) (blame)
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
~~Title: Efl.Net.Dialer.Websocket.Close_Reason~~
===== Description =====

%%Registered reasons for the CLOSE (opcode=0x8).%%

%%These are the well known reasons, with some ranges being defined using "_start" and "end" suffixes.%%

%%See https://tools.ietf.org/html/rfc6455#section-7.4.1%%

//Since 1.19//

{{page>:develop:api-include:efl:net:dialer:websocket:close_reason:description&nouser&nolink&nodate}}

===== Fields =====

{{page>:develop:api-include:efl:net:dialer:websocket:close_reason:fields&nouser&nolink&nodate}}

  * **normal** - %%Indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.%%
  * **going_away** - %%Indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.%%
  * **protocol_error** - %%Indicates that an endpoint is terminating the connection due to a protocol error.%%
  * **no_reason** - %%Reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that no status code was actually present.%%
  * **abruptly** - %%Reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.  It is designated for use in applications expecting a status code to indicate that the connection was closed abnormally, e.g., without sending or receiving a Close control frame.%%
  * **unexpected_data** - %%Indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g., an endpoint that understands only text data MAY send this if it receives a binary message).%%
  * **inconsistent_data** - %%Indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (e.g., non-UTF-8 data within a text message).%%
  * **policy_violation** - %%Indicates that an endpoint is terminating the connection because it has received a message that violates its policy.  This is a generic status code that can be returned when there is no other more suitable status code (e.g., 1003 or 1009) or if there is a need to hide specific details about the policy.%%
  * **too_big** - %%Indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.%%
  * **missing_extension** - %%Indicates that an endpoint (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 response message of the WebSocket handshake.  The list of extensions that are needed SHOULD appear in the reason part of the Close frame.  Note that this status code is not used by the server, because it can fail the WebSocket handshake instead.%%
  * **server_error** - %%Indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.%%
  * **iana_registry_start** - %%IANA registry starts at 3000%%
  * **iana_registry_end** - %%IANA registry ends at 3999%%
  * **private_start** - %%Applications can use range 4000-4999%%
  * **private_end** - %%Applications can use range 4000-4999%%

===== Signature =====

<code>
enum Efl.Net.Dialer.Websocket.Close_Reason {
    normal: 1000,
    going_away: 1001,
    protocol_error: 1002,
    no_reason: 1005,
    abruptly: 1006,
    unexpected_data: 1003,
    inconsistent_data: 1007,
    policy_violation: 1008,
    too_big: 1009,
    missing_extension: 1010,
    server_error: 1011,
    iana_registry_start: 3000,
    iana_registry_end: 3999,
    private_start: 4000,
    private_end: 4999
}
</code>

===== C signature =====

<code c>
typedef enum {
    EFL_NET_DIALER_WEBSOCKET_CLOSE_REASON_NORMAL = 1000,
    EFL_NET_DIALER_WEBSOCKET_CLOSE_REASON_GOING_AWAY = 1001,
    EFL_NET_DIALER_WEBSOCKET_CLOSE_REASON_PROTOCOL_ERROR = 1002,
    EFL_NET_DIALER_WEBSOCKET_CLOSE_REASON_NO_REASON = 1005,
    EFL_NET_DIALER_WEBSOCKET_CLOSE_REASON_ABRUPTLY = 1006,
    EFL_NET_DIALER_WEBSOCKET_CLOSE_REASON_UNEXPECTED_DATA = 1003,
    EFL_NET_DIALER_WEBSOCKET_CLOSE_REASON_INCONSISTENT_DATA = 1007,
    EFL_NET_DIALER_WEBSOCKET_CLOSE_REASON_POLICY_VIOLATION = 1008,
    EFL_NET_DIALER_WEBSOCKET_CLOSE_REASON_TOO_BIG = 1009,
    EFL_NET_DIALER_WEBSOCKET_CLOSE_REASON_MISSING_EXTENSION = 1010,
    EFL_NET_DIALER_WEBSOCKET_CLOSE_REASON_SERVER_ERROR = 1011,
    EFL_NET_DIALER_WEBSOCKET_CLOSE_REASON_IANA_REGISTRY_START = 3000,
    EFL_NET_DIALER_WEBSOCKET_CLOSE_REASON_IANA_REGISTRY_END = 3999,
    EFL_NET_DIALER_WEBSOCKET_CLOSE_REASON_PRIVATE_START = 4000,
    EFL_NET_DIALER_WEBSOCKET_CLOSE_REASON_PRIVATE_END = 4999
} Efl_Net_Dialer_Websocket_Close_Reason;
</code>