WebSocketServer.h

Go to the documentation of this file.

/*
 *     ____             _________                __                _
 *    / __ \___  ____ _/ /_  __(_)___ ___  ___  / /   ____  ____ _(_)____
 *   / /_/ / _ \/ __ `/ / / / / / __ `__ \/ _ \/ /   / __ \/ __ `/ / ___/
 *  / _, _/  __/ /_/ / / / / / / / / / / /  __/ /___/ /_/ / /_/ / / /__
 * /_/ |_|\___/\__,_/_/ /_/ /_/_/ /_/ /_/\___/_____/\____/\__, /_/\___/
 *                                                       /____/
 *
 *                  Barracuda Application Server
 *
 ****************************************************************************
 *                            HEADER
 *
 *   $Id: WebSocketServer.h 6056 2026-09-20 05:09:33Z wini $
 *
 *   COPYRIGHT:  Real Time Logic LLC, 2015 - 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://www.realtimelogic.com
 ****************************************************************************
 *
 *
 */
 
#ifndef _WebSocketServer_h
#define _WebSocketServer_h
 
#include <DynBuffer.h>
 
 
struct WSS;
struct WSSCB;
 
typedef void (*WSSCB_Frame)(
   struct WSSCB* o,struct WSS* wss,void* data,int len,int text);
 
 
typedef void (*WSSCB_Ping)(struct WSSCB* o,struct WSS* wss,void* data,int len);
 
 
typedef void (*WSSCB_Close)(struct WSSCB* o,struct WSS* wss,int status);
 
typedef struct WSSCB
{
#ifdef __cplusplus
   WSSCB(WSSCB_Frame frameFp, WSSCB_Close closeFp, WSSCB_Ping pingFp=0);
#endif 
   WSSCB_Frame frameFp;
   WSSCB_Close closeFp;
   WSSCB_Ping pingFp;
} WSSCB;
 
 
#define WSSCB_constructor(o, frame, close, ping) \
   (o)->frameFp=frame,(o)->closeFp=close,(o)->pingFp=ping
 
#ifdef __cplusplus
inline WSSCB::WSSCB(
   WSSCB_Frame frameFp, WSSCB_Close closeFp, WSSCB_Ping pingFp) {
   WSSCB_constructor(this, frameFp, closeFp, pingFp);
}
#endif 
 
 
typedef struct WSS
{
#ifdef __cplusplus
   WSS(WSSCB* cb, SoDisp* disp, int startSize, int expandSize);
 
   ~WSS();
 
   int upgrade(HttpRequest* req);
 
   int connect(HttpConnection* con);
 
   int write(const void* data, int len, bool isTxt);
 
   int close(int statusCode=1000);
 
      bool isValid();
 
#endif 
   SoDispCon super;
   DynBuffer db;
   WSSCB* cb;
   int endOfPacketIx;
} WSS;
 
 
#ifdef __cplusplus
extern "C" {
#endif
BA_API void WSS_constructor(
   WSS* o, WSSCB* cb, SoDisp* disp, int startSize, int expandSize);
BA_API void WSS_destructor(WSS* o);
BA_API int WSS_upgrade(WSS* o, HttpRequest* req);
BA_API int WSS_connect(WSS* o, HttpConnection* con);
BA_API int WSS_rawWrite(WSS* o, const void* data, int len, int opCode);
#define WSS_write(o, data, len, isTxt) WSS_rawWrite(o, data, len, isTxt?1:2)
BA_API int WSS_close(WSS* o, int statusCode);
#define WSS_isValid(o) SoDispCon_isValid((SoDispCon*)o)
#ifdef __cplusplus
}
 
inline WSS::WSS(WSSCB* cb, SoDisp* disp, int startSize, int expandSize) {
   WSS_constructor(this, cb, disp, startSize, expandSize);
}
inline WSS::~WSS() {
   WSS_destructor(this);
}
inline int WSS::upgrade(HttpRequest* req) {
   return WSS_upgrade(this, req);
}
inline int WSS::connect(HttpConnection* con) {
   return WSS_connect(this, con);
}
inline int WSS::write(const void* data, int len, bool isTxt) {
   return WSS_write(this, data, len,isTxt);
}
inline int WSS::close(int statusCode) {
   return  WSS_close(this, statusCode);
}
inline bool WSS::isValid() {
        return WSS_isValid(this) ? true : false; }
#endif
 
 /* end of WebSockets */
 
#endif