TsgcWebSocketClient › Events

TsgcWebSocketClient Events

Events you can handle, grouped by purpose, followed by the full alphabetical list.

Lifecycle

Name	Description
OnConnect	Fires when a WebSocket connection to the server has been successfully established.
OnDisconnect	Fires when the WebSocket connection has been dropped or closed.
OnError	Fires every time a WebSocket protocol error occurs on the connection.
OnHandshake	Fires when the client HTTP handshake is being built so custom headers can be added.
OnException	Fires whenever an unhandled exception is raised while processing the connection.
OnBeforeHeartBeat	Fires before each HeartBeat ping so the application can send a custom keep-alive message.
OnBeforeWatchDog	Fires before each WatchDog reconnection attempt so the application can adjust the target server or suppress the retry.
OnBeforeConnect	Fires before the client tries to connect to the server.

Data

Name	Description
OnMessage	Fires every time the server sends a text message to the client.
OnBinary	Fires every time the server sends a binary message to the client.
OnFragmented	Fires for every fragment received when Options.FragmentedMessages is frgAll or frgOnlyFragmented.

Reliability

Name	Description
OnLoadBalancerError	Fires when LoadBalancer is enabled and an error occurs while communicating with the Load Balancer Server.

Security

Name	Description
OnSSLGetHandler	Fires before the SSL handler is created so a custom handler instance can be supplied.
OnSSLAfterCreateHandler	Fires after the SSL handler has been created so its properties can be customized.
OnSSLVerifyPeer	Fires when VerifyCertificate is enabled so the application can accept or reject the server certificate.
OnSChannelVerifyPeer	Fires when SChannel is the TLS IOHandler so the application can verify the server certificate.

All Events (alphabetical)

Name	Description
OnBeforeConnect	Fires before the client tries to connect to the server.
OnBeforeHeartBeat	Fires before each HeartBeat ping so the application can send a custom keep-alive message.
OnBeforeWatchDog	Fires before each WatchDog reconnection attempt so the application can adjust the target server or suppress the retry.
OnBinary	Fires every time the server sends a binary message to the client.
OnConnect	Fires when a WebSocket connection to the server has been successfully established.
OnDisconnect	Fires when the WebSocket connection has been dropped or closed.
OnError	Fires every time a WebSocket protocol error occurs on the connection.
OnException	Fires whenever an unhandled exception is raised while processing the connection.
OnFragmented	Fires for every fragment received when Options.FragmentedMessages is frgAll or frgOnlyFragmented.
OnHandshake	Fires when the client HTTP handshake is being built so custom headers can be added.
OnLoadBalancerError	Fires when LoadBalancer is enabled and an error occurs while communicating with the Load Balancer Server.
OnMessage	Fires every time the server sends a text message to the client.
OnSChannelVerifyPeer	Fires when SChannel is the TLS IOHandler so the application can verify the server certificate.
OnSSLAfterCreateHandler	Fires after the SSL handler has been created so its properties can be customized.
OnSSLGetHandler	Fires before the SSL handler is created so a custom handler instance can be supplied.
OnSSLVerifyPeer	Fires when VerifyCertificate is enabled so the application can accept or reject the server certificate.