WsClientLib.h

Go to the documentation of this file.

/*
 *     ____             _________                __                _
 *    / __ \___  ____ _/ /_  __(_)___ ___  ___  / /   ____  ____ _(_)____
 *   / /_/ / _ \/ __ `/ / / / / / __ `__ \/ _ \/ /   / __ \/ __ `/ / ___/
 *  / _, _/  __/ /_/ / / / / / / / / / / /  __/ /___/ /_/ / /_/ / / /__
 * /_/ |_|\___/\__,_/_/ /_/ /_/_/ /_/ /_/\___/_____/\____/\__, /_/\___/
 *                                                       /____/
 *
 *                 SharkSSL Embedded SSL/TLS Stack
 ****************************************************************************
 *   PROGRAM MODULE
 *
 *   $Id: WsClientLib.h 6673 2026-10-29 16:58:52Z wini $
 *
 *   COPYRIGHT:  Real Time Logic LLC, 2014 - 2026
 *
 *   This software is copyrighted by and is the sole property of Real
 *   Time Logic LLC.  All rights, title, ownership, or other interests in
 *   the software remain the property of Real Time Logic LLC.  This
 *   software may only be used in accordance with the terms and
 *   conditions stipulated in the corresponding license agreement under
 *   which the software has been supplied.  Any unauthorized use,
 *   duplication, transmission, distribution, or disclosure of this
 *   software is expressly forbidden.
 *
 *   This Copyright notice may not be removed or modified without prior
 *   written consent of Real Time Logic LLC.
 *
 *   Real Time Logic LLC. reserves the right to modify this software
 *   without notice.
 *
 *               http://realtimelogic.com
 *               http://sharkssl.com
 ****************************************************************************
 *
 */
 
#ifndef _WsClientLib_h
#define _WsClientLib_h
 
 
#include "selib.h"
 
#ifdef _DOXYGEN
/* For documentation purposes */
#define WSC_DUAL
#endif
 
#define WSOP_Text   0x81
#define WSOP_Binary 0x82
#define WSOP_Close  0x88
#define WSOP_Ping   0x89
#define WSOP_Pong   0x8A
 /* end group WebSocketOpcodes */ 
 
#define WSC_TLS_AUTH_FAILED -105
 
 
 
typedef struct
{
#ifdef WSC_DUAL
   U8* recBuf;
   U8* sendBuf;
   int recBufLen;
   int sendBufLen;
#endif
   SharkSslCon* scon;
   SOCKET* sock;
   int frameLen;
   int bytesRead;
 
   /* Begin private */
   U8* overflowPtr; /* Set if: consumed more data from stream than frame len */ 
   int overflowLen; /* overflowPtr len is used internally in wsRawRead */
   int frameHeaderIx; /* Cursor used when reading frameHeader from socket */
   U8 frameHeader[4]; /*[0] FIN+opcode, [1] Payload len, [2-3] Ext payload len*/
   /* End private */
 
   U8 isTimeout;
} WscState;
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
int wscProtocolHandshake(WscState* wss,U32 tmo, const char* host,
                         const char* path,const char* origin);
 
 
int wscSendBin(WscState* wss, U8* buf, int len);
 
int wscSendCtrl(WscState* wss, U8 opCode, const U8* buf,int len);
 
int wscClose(WscState* wss, int statusCode);
 
 
int wscRead(WscState* wss, U8 **buf, U32 timeout);
 
#ifdef __cplusplus
}
#endif
 /* end group WsClientLib */ 
 
#endif