WSClientGWrapper 1.0.0

WebSocket Client Generic Wrapper (WSClientGWrapper)

Implementation of a generic wrapper for the Microsoft ClientWebSocket class (.NET Core)

How to use it?

• The class WSClientGWrapper<TSend, TResponse> is the main definition of the generic wrapper, where the TSend is the type of data to be sended, and the TResponse is the type of the data that will be received.
• To use the string type to send/receive data, you can use the SimpleWebSocketClientWrapper class.

Steps :

1. Instantiate a new wrapper object by choosing one of the two options mentioned above. e.g.

   var wrapper = new WSClientGWrapper<string, string>("wss://api.com/customers");
   

   **P.S 😗*

   • The 2nd argument in the constructor fixRemoteCertValidation by default false, is used to enable/disable remote certificate validation.

     • For WebSocket secure connection wss:// we need to validate certificate, but in some cases we're gone be using self-signed certificate, and it gaves errors on connecting the WebSocket (validation errors), to skip validation set the 2nd parameter value to true.

   • [Optional] Now we have our wrapper object we need to set the response converter callback :

     • What is this callback ?
       • This callback is used to convert the response data from byte[] to TResponse, but we need to define how the data will be converted, by default the data is converted to string data type by using :

         Convert.ChangeType(Encoding.UTF8.GetString(bytesData), ...);
         

2. Now we need to define all needed callbacks :

   • OnConnect :

     • To be called on the WebSocket connection.
     • Generally here where you need to add initialization calls (wrapper.SendMessage(...)).
     • returns the current wrapper.

   • OnDisconnect :

     • To be called on the WebSocket disconnection.
     • returns the current wrapper.

   • OnMessage :

     • To be called on message arrival.
     • Receives in argument the WSClientGWrapperArgs :
       • This class contains :
         • Data : the message payload.
         • Endpoint : the current URI where the WebSocket is connected to it.\
         • Wrapper : is the current wrapper object.

   • OnError :

     • To be called on any error encountered.
     • Receives in argument the WSClientGWrapperErrorArgs :
       • This class contains :
         • Message : the error message.
         • Endpoint : the current URI where the WebSocket is connected to it.\
         • Wrapper : is the current wrapper object.
3. Now we need to connect the WebSocket and start listening by calling the connect method :

   wrapper.Connect();
   

If you need to change the WebSocket URI without connecting the socket, use the RebuildClient(string baseAddress, bool fixRemoteCertValidation = false)

If you need to change the WebSocket URI and create a new connection, call the RebuildClientAndConnect(string baseAddress, bool fixRemoteCertValidation = false).

Disconnect the WebSocket :

• To disconnect the client, use the disconnect method.