TsgcWebSocketLoadBalancerServer › Methods

TsgcWebSocketLoadBalancerServer Methods

Public methods grouped by purpose, followed by the full alphabetical list.

Connection

NameDescription
StartStarts the load balancer from a secondary thread so the calling thread is not blocked while bindings are opened.
StopStops the load balancer from a secondary thread so the calling thread is not blocked while connections are closed.
ReStartStops and then restarts the load balancer from a secondary thread, useful after changing bindings or ports at runtime.
DisconnectAllDisconnects every active client connection and every registered backup server while keeping the load balancer listening for new connections.

Messaging

NameDescription
BroadcastFans a WebSocket message out across every backup server in the cluster, optionally filtered by channel, protocol, or connection GUID list.
WriteDataSends a WebSocket message to a single client identified by its connection GUID, routing the frame through the backup server that owns the session.
PingSends a WebSocket ping frame to every client connected through the load balancer.

HTTP/2 Push

NameDescription
PushPromiseAddPreLoadLinksRegisters an HTTP/2 Server Push rule that preloads a set of related resources whenever a matching request path is served by the load balancer.
PushPromiseRemovePreLoadLinksRemoves the HTTP/2 Server Push rule previously registered on the load balancer for the given request path.

All Methods (alphabetical)

NameDescription
BroadcastFans a WebSocket message out across every backup server in the cluster, optionally filtered by channel, protocol, or connection GUID list.
DisconnectAllDisconnects every active client connection and every registered backup server while keeping the load balancer listening for new connections.
PingSends a WebSocket ping frame to every client connected through the load balancer.
PushPromiseAddPreLoadLinksRegisters an HTTP/2 Server Push rule that preloads a set of related resources whenever a matching request path is served by the load balancer.
PushPromiseRemovePreLoadLinksRemoves the HTTP/2 Server Push rule previously registered on the load balancer for the given request path.
ReStartStops and then restarts the load balancer from a secondary thread, useful after changing bindings or ports at runtime.
StartStarts the load balancer from a secondary thread so the calling thread is not blocked while bindings are opened.
StopStops the load balancer from a secondary thread so the calling thread is not blocked while connections are closed.
WriteDataSends a WebSocket message to a single client identified by its connection GUID, routing the frame through the backup server that owns the session.