This package includes the SharkSSL lite library and header files.

Dependents:   WebSocket-Client-Example SharkMQ-LED-Demo

Embed: (wiki syntax)

« Back to documentation index

WscReadState Struct Reference

WscReadState Struct Reference
[WsClientLib]

The WebSocket protocol is frame based and the following struct keeps state information for wscRead. More...

#include <WsClientLib.h>

Data Fields

int frameLen
 The WebSocket frame length.
int bytesRead
 Read frame data until: frameLen - bytesRead = 0.
U8 isTimeout
 Set when the read function returns due to a timeout.

Detailed Description

The WebSocket protocol is frame based and the following struct keeps state information for wscRead.

Definition at line 79 of file WsClientLib.h.


Field Documentation

int bytesRead

Read frame data until: frameLen - bytesRead = 0.

Definition at line 84 of file WsClientLib.h.

int frameLen

The WebSocket frame length.

Definition at line 82 of file WsClientLib.h.

Set when the read function returns due to a timeout.

Definition at line 92 of file WsClientLib.h.