Skip to main content
WebSocket Protocol Component API Functions

The WebSocket Protocol Component API defines these functions.

In this section

TopicDescription

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.