TsgcWebSocketLoadBalancerServer › Events

TsgcWebSocketLoadBalancerServer Events

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

Lifecycle

Name	Description
OnConnect	Fires when a WebSocket connection (client or backend server) is established with the load balancer.
OnDisconnect	Fires when any WebSocket connection accepted by the load balancer is closed.
OnHandshake	Fires after the load balancer validates an incoming WebSocket handshake and before the HTTP response is returned.
OnError	Fires when the load balancer detects an error on one of its accepted connections.
OnException	Fires when an unhandled Delphi exception is caught by the load balancer while processing a connection.

Data

Name	Description
OnMessage	Fires when the load balancer receives a text WebSocket frame on one of its own sessions.
OnBinary	Fires when the load balancer itself receives a binary WebSocket frame on one of its downstream sessions.
OnFragmented	Fires when the load balancer receives a fragmented WebSocket frame on one of its own sessions.
OnRawMessage	Fires when any WebSocket text frame arrives, before higher-level protocols or the forwarder process it.

Client events

Name	Description
OnClientConnect	Fires when a downstream client finishes the WebSocket handshake against the load balancer and is paired with a backend server.
OnClientDisconnect	Fires when a downstream client session is dropped from the load balancer, either because the client left or because the backend terminated.
OnClientMessage	Fires when a text frame is received from a downstream client before it is forwarded to the selected backend server.
OnClientBinary	Fires when a binary frame is received from a downstream client before it is forwarded to the selected backend server.
OnClientFragmented	Fires when a fragmented binary frame is received from a downstream client before it is forwarded to the backend server.

Backend events

Name	Description
OnServerConnect	Fires when a backend WebSocket server connects to the load balancer to register itself.
OnServerDisconnect	Fires when a backend server disconnects from the load balancer.
OnServerReady	Fires when a backend server has finished registering with the load balancer and is ready to accept traffic.
OnBeforeSendServerBinding	Fires before the load balancer sends a backend server binding (host, port, protocol) to a newly accepted downstream client.

HTTP

Name	Description
OnLoadBalancerHTTPRequest	Fires for each incoming HTTP request received by the load balancer before it is forwarded to the selected backend server.
OnLoadBalancerHTTPResponse	Fires after the load balancer receives the HTTP response from the backend and before it is returned to the downstream client.

Security

Name	Description
OnSSLGetHandler	Fires before the SSL handler is created so a custom server-side handler instance can be supplied to the load balancer.
OnSSLAfterCreateHandler	Fires after the load balancer creates the SSL handler so its properties can be customized before the TLS handshake.

All Events (alphabetical)

Name	Description
OnBeforeSendServerBinding	Fires before the load balancer sends a backend server binding (host, port, protocol) to a newly accepted downstream client.
OnBinary	Fires when the load balancer itself receives a binary WebSocket frame on one of its downstream sessions.
OnClientBinary	Fires when a binary frame is received from a downstream client before it is forwarded to the selected backend server.
OnClientConnect	Fires when a downstream client finishes the WebSocket handshake against the load balancer and is paired with a backend server.
OnClientDisconnect	Fires when a downstream client session is dropped from the load balancer, either because the client left or because the backend terminated.
OnClientFragmented	Fires when a fragmented binary frame is received from a downstream client before it is forwarded to the backend server.
OnClientMessage	Fires when a text frame is received from a downstream client before it is forwarded to the selected backend server.
OnConnect	Fires when a WebSocket connection (client or backend server) is established with the load balancer.
OnDisconnect	Fires when any WebSocket connection accepted by the load balancer is closed.
OnError	Fires when the load balancer detects an error on one of its accepted connections.
OnException	Fires when an unhandled Delphi exception is caught by the load balancer while processing a connection.
OnFragmented	Fires when the load balancer receives a fragmented WebSocket frame on one of its own sessions.
OnHandshake	Fires after the load balancer validates an incoming WebSocket handshake and before the HTTP response is returned.
OnLoadBalancerHTTPRequest	Fires for each incoming HTTP request received by the load balancer before it is forwarded to the selected backend server.
OnLoadBalancerHTTPResponse	Fires after the load balancer receives the HTTP response from the backend and before it is returned to the downstream client.
OnMessage	Fires when the load balancer receives a text WebSocket frame on one of its own sessions.
OnRawMessage	Fires when any WebSocket text frame arrives, before higher-level protocols or the forwarder process it.
OnServerConnect	Fires when a backend WebSocket server connects to the load balancer to register itself.
OnServerDisconnect	Fires when a backend server disconnects from the load balancer.
OnServerReady	Fires when a backend server has finished registering with the load balancer and is ready to accept traffic.
OnSSLAfterCreateHandler	Fires after the load balancer creates the SSL handler so its properties can be customized before the TLS handshake.
OnSSLGetHandler	Fires before the SSL handler is created so a custom server-side handler instance can be supplied to the load balancer.