1.7.3 Web Socket Server System Service Interface

Data Types and Constants Summary

NameDescription
SYS_WSS_KA_TIMER_PERIODDecides the accuracy of the client timeout
SYS_WSS_CLIENT_KEY_SIZEArray size for holding the client key
SYS_WSS_CLIENT_KEY_SIZE_DECODEDDecoded client key size as per the RFC6455
SYS_WSS_SERVER_KEY_SIZEArray saze for holding the server key
SYS_WSS_SHA1_DIGEST_SIZESHA1 digest size -server key genartion
SYS_WSS_HTTP_VERSION_0_9HTTP vesrion 0.9
SYS_WSS_HTTP_VERSION_1_0HTTP version 1.0
SYS_WSS_HTTP_VERSION_1_1HTTP version 1.1
SYS_WSS_STATUS_CODE_LENClosing Status code lenth as per RFC6455
SYS_WSS_GUIDWebSocket GUID as per Section 1.3 of RFC 6455
SYS_WSS_CONFIGUsed for passing on the configuration(port and TLS) for socket connection
SYS_WSS_HANDSHAKE_CTXTStores the handshake information of a client.
SYS_WSS_FRAME_HEADERIdentifies the frame format as defined by RFC6455.
SYS_WSS_RXDATAStores the data received from the client along with the datalength.
SYS_WSS_RESULTIdentifies the return values for the WSS system service APIs.
SYS_WSS_STATEIdentifies the state machine values of the WSS system service.
SYS_WSS_FRAMEIdentifies the frame types as defined by the RFC6455.
SYS_WSS_EVENTSIdentifies the events reported to the application using the call back function.
SYS_WSS_STATUS_CODEIdentifies status code to be used in the closing handshake as defined by RF6455.

Initialization functions Summary

NameDescription
SYS_WSS_InitializeReturns wss object handle after initialization of data structures and timers of the WSS system service
SYS_WSS_DeinitializeDeinitialization of data structures of the WSS system service

Data Exchange functions Summary

NameDescription
SYS_WSS_sendMessageReturns failure or success after sending the data to the client.
SYS_WSS_register_callbackReturns success after registration of the user call back function.
SYS_WSS_CloseConnectionReturns success after sending a close frame to the client.
SYS_WSS_PingClientReturns success after sending a ping frame to the client.