WebSocket Protocol Component API
Overview of the WebSocket Protocol Component API technology.
To develop WebSocket Protocol Component API, you need these headers:
For programming guidance for this technology, see:
Enumerations
| WEB_SOCKET_ACTION Specifies actions to be taken by WebSocket applications. |
| WEB_SOCKET_ACTION_QUEUE Specifies the action types returned by WebSocketGetAction. |
| WEB_SOCKET_BUFFER_TYPE Specifies the bit values used to construct the WebSocket frame header. |
| WEB_SOCKET_CLOSE_STATUS Specifies the WebSocket close status. |
| WEB_SOCKET_PROPERTY_TYPE Specifies a WebSocket property type. |
Functions
| WebSocketAbortHandle Aborts a WebSocket session handle created by WebSocketCreateClientHandle or WebSocketCreateServerHandle. |
| WebSocketBeginClientHandshake Begins the client-side handshake. |
| WebSocketBeginServerHandshake Begins the server-side handshake. |
| WebSocketCompleteAction Completes an action started by WebSocketGetAction. |
| WebSocketCreateClientHandle Creates a client-side WebSocket session handle. |
| WebSocketCreateServerHandle Creates a server-side WebSocket session handle. |
| WebSocketDeleteHandle Deletes a WebSocket session handle created by WebSocketCreateClientHandle or WebSocketCreateServerHandle. |
| WebSocketEndClientHandshake Completes the client-side handshake. |
| WebSocketEndServerHandshake Completes the server-side handshake. |
| WebSocketGetAction Returns an action from a call to WebSocketSend, WebSocketReceive or WebSocketCompleteAction. |
| WebSocketGetGlobalProperty Gets a single WebSocket property. |
| WebSocketReceive Adds a receive operation to the protocol component operation queue. |
| WebSocketSend Adds a send operation to the protocol component operation queue. |
Structures
| WEB_SOCKET_BUFFER Contains data for a specific WebSocket action. |
| WEB_SOCKET_HTTP_HEADER Contains an HTTP header. |
| WEB_SOCKET_PROPERTY Contains a single WebSocket property. |