updates on WebSocket constants

Signed-off-by: Demin Yin <deminy@deminy.net>

Author: deminy

src/swoole/constants.php

@@ -390,22 +390,51 @@
 define('SWOOLE_WORKER_BUSY', 1);
 define('SWOOLE_WORKER_IDLE', 2);
 define('SWOOLE_WORKER_EXIT', 3);
+
+// WebSocket flags.
+define('SWOOLE_WEBSOCKET_FLAG_FIN', 1);
+define('SWOOLE_WEBSOCKET_FLAG_RSV1', 4);
+define('SWOOLE_WEBSOCKET_FLAG_RSV2', 8);
+define('SWOOLE_WEBSOCKET_FLAG_RSV3', 16);
+define('SWOOLE_WEBSOCKET_FLAG_MASK', 32);
+define('SWOOLE_WEBSOCKET_FLAG_COMPRESS', 2); // Used to indicate if a frame is compressed or not.
+
+/*
+ * WebSocket connection status. They are used as value of field "websocket_status" in the array returned from method
+ * \Swoole\Server::getClientInfo().
+ *
+ * @see \Swoole\Server::getClientInfo()
+ * @see \Swoole\Server::connection_info()
+ */
 define('SWOOLE_WEBSOCKET_STATUS_CONNECTION', 1);
 define('SWOOLE_WEBSOCKET_STATUS_HANDSHAKE', 2);
 define('SWOOLE_WEBSOCKET_STATUS_ACTIVE', 3);
 define('SWOOLE_WEBSOCKET_STATUS_CLOSING', 4);
+// Next five constants are kept for backward compatibility.
+define('WEBSOCKET_STATUS_CONNECTION', SWOOLE_WEBSOCKET_STATUS_CONNECTION);
+define('WEBSOCKET_STATUS_HANDSHAKE', SWOOLE_WEBSOCKET_STATUS_HANDSHAKE);
+define('WEBSOCKET_STATUS_FRAME', SWOOLE_WEBSOCKET_STATUS_ACTIVE);
+define('WEBSOCKET_STATUS_ACTIVE', SWOOLE_WEBSOCKET_STATUS_ACTIVE);
+define('WEBSOCKET_STATUS_CLOSING', SWOOLE_WEBSOCKET_STATUS_CLOSING);
+
+// WebSocket opcodes.
+// @see https://datatracker.ietf.org/doc/html/rfc6455#section-11.8 WebSocket Opcode Registry
 define('SWOOLE_WEBSOCKET_OPCODE_CONTINUATION', 0);
 define('SWOOLE_WEBSOCKET_OPCODE_TEXT', 1);
 define('SWOOLE_WEBSOCKET_OPCODE_BINARY', 2);
 define('SWOOLE_WEBSOCKET_OPCODE_CLOSE', 8);
 define('SWOOLE_WEBSOCKET_OPCODE_PING', 9);
 define('SWOOLE_WEBSOCKET_OPCODE_PONG', 10);
-define('SWOOLE_WEBSOCKET_FLAG_FIN', 1);
-define('SWOOLE_WEBSOCKET_FLAG_RSV1', 4);
-define('SWOOLE_WEBSOCKET_FLAG_RSV2', 8);
-define('SWOOLE_WEBSOCKET_FLAG_RSV3', 16);
-define('SWOOLE_WEBSOCKET_FLAG_MASK', 32);
-define('SWOOLE_WEBSOCKET_FLAG_COMPRESS', 2);
+// Next six constants are kept for backward compatibility.
+define('WEBSOCKET_OPCODE_CONTINUATION', SWOOLE_WEBSOCKET_OPCODE_CONTINUATION);
+define('WEBSOCKET_OPCODE_TEXT', SWOOLE_WEBSOCKET_OPCODE_TEXT);
+define('WEBSOCKET_OPCODE_BINARY', SWOOLE_WEBSOCKET_OPCODE_BINARY);
+define('WEBSOCKET_OPCODE_CLOSE', SWOOLE_WEBSOCKET_OPCODE_CLOSE);
+define('WEBSOCKET_OPCODE_PING', SWOOLE_WEBSOCKET_OPCODE_PING);
+define('WEBSOCKET_OPCODE_PONG', SWOOLE_WEBSOCKET_OPCODE_PONG);
+
+// WebSocket status codes.
+// @see https://datatracker.ietf.org/doc/html/rfc6455#section-7.4.1 Status Code Definitions
 define('SWOOLE_WEBSOCKET_CLOSE_NORMAL', 1000);
 define('SWOOLE_WEBSOCKET_CLOSE_GOING_AWAY', 1001);
 define('SWOOLE_WEBSOCKET_CLOSE_PROTOCOL_ERROR', 1002);
@@ -418,29 +447,19 @@
 define('SWOOLE_WEBSOCKET_CLOSE_EXTENSION_MISSING', 1010);
 define('SWOOLE_WEBSOCKET_CLOSE_SERVER_ERROR', 1011);
 define('SWOOLE_WEBSOCKET_CLOSE_TLS', 1015);
-define('WEBSOCKET_STATUS_CONNECTION', 1);
-define('WEBSOCKET_STATUS_HANDSHAKE', 2);
-define('WEBSOCKET_STATUS_FRAME', 3);
-define('WEBSOCKET_STATUS_ACTIVE', 3);
-define('WEBSOCKET_STATUS_CLOSING', 4);
-define('WEBSOCKET_OPCODE_CONTINUATION', 0);
-define('WEBSOCKET_OPCODE_TEXT', 1);
-define('WEBSOCKET_OPCODE_BINARY', 2);
-define('WEBSOCKET_OPCODE_CLOSE', 8);
-define('WEBSOCKET_OPCODE_PING', 9);
-define('WEBSOCKET_OPCODE_PONG', 10);
-define('WEBSOCKET_CLOSE_NORMAL', 1000);
-define('WEBSOCKET_CLOSE_GOING_AWAY', 1001);
-define('WEBSOCKET_CLOSE_PROTOCOL_ERROR', 1002);
-define('WEBSOCKET_CLOSE_DATA_ERROR', 1003);
-define('WEBSOCKET_CLOSE_STATUS_ERROR', 1005);
-define('WEBSOCKET_CLOSE_ABNORMAL', 1006);
-define('WEBSOCKET_CLOSE_MESSAGE_ERROR', 1007);
-define('WEBSOCKET_CLOSE_POLICY_ERROR', 1008);
-define('WEBSOCKET_CLOSE_MESSAGE_TOO_BIG', 1009);
-define('WEBSOCKET_CLOSE_EXTENSION_MISSING', 1010);
-define('WEBSOCKET_CLOSE_SERVER_ERROR', 1011);
-define('WEBSOCKET_CLOSE_TLS', 1015);
+// Next twelve constants are kept for backward compatibility.
+define('WEBSOCKET_CLOSE_NORMAL', SWOOLE_WEBSOCKET_CLOSE_NORMAL);
+define('WEBSOCKET_CLOSE_GOING_AWAY', SWOOLE_WEBSOCKET_CLOSE_GOING_AWAY);
+define('WEBSOCKET_CLOSE_PROTOCOL_ERROR', SWOOLE_WEBSOCKET_CLOSE_PROTOCOL_ERROR);
+define('WEBSOCKET_CLOSE_DATA_ERROR', SWOOLE_WEBSOCKET_CLOSE_DATA_ERROR);
+define('WEBSOCKET_CLOSE_STATUS_ERROR', SWOOLE_WEBSOCKET_CLOSE_STATUS_ERROR);
+define('WEBSOCKET_CLOSE_ABNORMAL', SWOOLE_WEBSOCKET_CLOSE_ABNORMAL);
+define('WEBSOCKET_CLOSE_MESSAGE_ERROR', SWOOLE_WEBSOCKET_CLOSE_MESSAGE_ERROR);
+define('WEBSOCKET_CLOSE_POLICY_ERROR', SWOOLE_WEBSOCKET_CLOSE_POLICY_ERROR);
+define('WEBSOCKET_CLOSE_MESSAGE_TOO_BIG', SWOOLE_WEBSOCKET_CLOSE_MESSAGE_TOO_BIG);
+define('WEBSOCKET_CLOSE_EXTENSION_MISSING', SWOOLE_WEBSOCKET_CLOSE_EXTENSION_MISSING);
+define('WEBSOCKET_CLOSE_SERVER_ERROR', SWOOLE_WEBSOCKET_CLOSE_SERVER_ERROR);
+define('WEBSOCKET_CLOSE_TLS', SWOOLE_WEBSOCKET_CLOSE_TLS);
 
 /*
  * The minimum number of milliseconds that can be used for time-related operations (e.g., timeout, time intervals, etc)