Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages

kStatus kHttpServerChannel_ProcessWebSocketRequest | ( | kHttpServerChannel | channel,
|  | kBool | shouldAccept,
|  | kWebSocket * | webSocket
| ) |  |

Processes a websocket request.

This function encapsulates WebSocket HTTP handshaking. Note that a WebSocket object will not be always be created, even in the event of success (e.g., if the upgrade response indicates that the client should request a different version).

In any case, a response will be generated and the HTTP server channel object should not be used again after this function returns.

Parameters

  channel | Channel object.
  shouldAccept | Should the incoming request be accepted?
  webSocket | Receives WebSocket object, or null if no WebSocket created.

Returns
  Operation status.