From dc7edd2e4626a81033176cfea702925cfffe8137 Mon Sep 17 00:00:00 2001 From: kevin Date: Fri, 29 Nov 2024 16:42:07 -0500 Subject: [PATCH] cwWebsock.h : Update documentation of create() args. --- cwWebSock.h | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/cwWebSock.h b/cwWebSock.h index f4e528e..90ec5e3 100644 --- a/cwWebSock.h +++ b/cwWebSock.h @@ -39,16 +39,16 @@ namespace cw rc_t create( handle_t& h, - cbFunc_t cbFunc, - void* cbArg, - const char* physRootDir, - const char* dfltHtmlPageFn, - int port, - const protocol_t* protocolA, - unsigned protocolN, - unsigned queueBlkCnt, - unsigned queueBlkByteCnt, - bool extraLogsFl); + cbFunc_t cbFunc, // websocket callback function + void* cbArg, // first arg. to websocket callback function + const char* physRootDir, // path to 'dfltHtmlPageFn' + const char* dfltHtmlPageFn, // websockets enabled HTML/JS app + int port, // websocket port + const protocol_t* protocolA, // incoming msg's larger than this will be broken into multiple parts + unsigned protocolN, // outgoing msg's larger than this will be broken into multiple parts + unsigned queueBlkCnt, // count of memory blocks in the outgoing non-blocking queue (See: cwNbMpScQueue) + unsigned queueBlkByteCnt, // size of each non-blocking memory block + bool extraLogsFl); // true if extra internal websocket logs should be generated rc_t destroy( handle_t& h );