WsClientLib

Sends a WebSocket close control frame to the server and closes the connection.

Parameters:

s	the SharkSslCon object.
sock	the SOCKET object.
statusCode	is a WebSocket status code.

Upgrades (morphs) an HTTPS request/response pair to a WebSocket connection.

Sends the HTTP request header to the server and validates the server's HTTP response header -- the function simulates a very basic HTTP client library. The function is designed to be as simple as possible and the code is, for this reason, making a few assumptions that could fail when used with a non traditional HTTP server. Read the comments in the source code file WsClientLib.c if you should experience problems.

Parameters:

wss	the WebSocket protocol state information is stored in this structure. All wss attributes must be initialized to zero before calling this function for the first time.
s	the SharkSslCon object
sock	the SOCKET object
tmo	in milliseconds. The timeout can be set to INFINITE_TMO.
host	is the server's host name
path	is the path component of the wss URL and the path must be to the server's WebSocket service.
origin	some WebSocket server's may require an origin URL: http://tools.ietf.org/html/rfc6455#section-10.2. Set the parameter to NULL if it's not required by the server. The Origin header should only be required by a server when the request is sent from a browser.

Returns:

Zero success.

Wait for WebSocket frames sent by the server.

The function returns when data is available or on timeout. The function returns zero on timeout, but the peer can send zero length frames so you must verify that it is a timeout by checking the status of WscReadState::isTimeout.

The WebSocket protocol is frame based, but the function can return a fragment before the complete WebSocket frame is received if the frame sent by the peer is larger than the SharkSSL receive buffer. The frame length is returned in WscReadState::frameLen and the data consumed thus far is returned in WscReadState::bytesRead. The complete frame is consumed when frameLen == bytesRead.

Parameters:

wss	is the WebSocket read state.
s	the SharkSslCon object.
sock	the SOCKET object.
buf	is a pointer set to the SharkSSL receive buffer offset to the start of the WebSocket payload data.
timeout	in milliseconds. The timeout can be set to INFINITE_TMO.

Returns:

The payload data length or zero for zero length frames and timeout. The function returns a negative value on error.

Sends binary data to server.

The function sets the WS frame header's opcode to binary. The WS protocol supports two payload frame types, UTF8 and binary (RFC6455: 5.6 Data Frames). We are assuming that you will be using the binary protocol for all data exchange.

Sends a WebSocket control frame.

The code is used internally by the WebSocket functions. You can also use this function to send your own control frames such as WSOP_Ping.

See RFC6455: 5.5. Control Frames