WuKongIM Docs

Client Protocols

Reference the current Gateway lifecycle and WKProto packet boundary.

Clients establish long-lived connections through Gateway TCP or WebSocket listeners. The current public baseline uses the same WKProto semantics for negotiation, send, receive acknowledgement, and heartbeat.

A protocol is not an HTTP API

TCP binary frames and WebSocket messages do not belong in OpenAPI. This section records wire and Gateway behavior without inventing HTTP paths.

Current boundary

  • The public core contains only CONNECT/CONNACK, SEND/SENDACK, RECV/RECVACK, and PING/PONG.
  • DISCONNECT, SUB, and SUBACK are currently codec contracts, not published product Gateway entry points.
  • The current product Gateway reserves EVENT only for benchmark terminal-fence request and acknowledgement; it is not an application event API.
  • WebSocket can carry WKProto bytes. The JSON-RPC bridge supports the pinned EasySDK core online path; the matrix marks every other method experimental or missing.

See Shared Dictionaries for numeric meanings and Authentication & Security for the production trust boundary.

On this page