TsgcWSCircuitBreaker › Methods

TsgcWSCircuitBreaker Methods

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

Execution

Name	Description
Execute	Runs a protected action; checks IsCallAllowed first and records success / failure / slow automatically.
ExecuteWithResult	Runs a protected action that returns a TObject and reports the result via an out parameter.
IsCallAllowed	Returns True when a new call is currently allowed for the given key; advances HalfOpen trial accounting.

Recording

Name	Description
RecordSuccess	Records a successful call; advances HalfOpen -> Closed when trial calls succeed.
RecordFailure	Records a failure against a key; applies Classification, updates counters and may open the circuit.
RecordMessageSuccess	Server-side hook that records a successful message on ServerKey.
RecordMessageError	Server-side hook that records a message failure on ServerKey.

Integration

Name	Description
IsConnectionAllowed	Server-side gatekeeper that returns False while the ServerKey circuit is Open.
IsMessageAllowed	Server-side gatekeeper that returns False when the ServerKey circuit is Open and rejects the message.
RegisterConnection	Server-side hook that tracks a new connection (reserved for future per-IP metrics).
UnregisterConnection	Server-side hook that stops tracking a disconnected connection (counterpart of RegisterConnection).

State control

Name	Description
ForceOpen	Manually moves the circuit for the given key into the Open state.
ForceClose	Manually moves the circuit for the given key back to the Closed state.
Reset	Clears the state, rolling-window counters and last-success payload for a single key.
ResetAll	Clears every tracked circuit, every rolling-window counter and all aggregate Metrics.

Persistence

Name	Description
SaveStateToFile	Persists every tracked circuit's state and counters to a file so they survive a restart.
LoadStateFromFile	Restores circuit states and counters from a file previously written by SaveStateToFile.

All Methods (alphabetical)

Name	Description
Execute	Runs a protected action; checks IsCallAllowed first and records success / failure / slow automatically.
ExecuteWithResult	Runs a protected action that returns a TObject and reports the result via an out parameter.
ForceClose	Manually moves the circuit for the given key back to the Closed state.
ForceOpen	Manually moves the circuit for the given key into the Open state.
IsCallAllowed	Returns True when a new call is currently allowed for the given key; advances HalfOpen trial accounting.
IsConnectionAllowed	Server-side gatekeeper that returns False while the ServerKey circuit is Open.
IsMessageAllowed	Server-side gatekeeper that returns False when the ServerKey circuit is Open and rejects the message.
LoadStateFromFile	Restores circuit states and counters from a file previously written by SaveStateToFile.
RecordFailure	Records a failure against a key; applies Classification, updates counters and may open the circuit.
RecordMessageError	Server-side hook that records a message failure on ServerKey.
RecordMessageSuccess	Server-side hook that records a successful message on ServerKey.
RecordSuccess	Records a successful call; advances HalfOpen -> Closed when trial calls succeed.
RegisterConnection	Server-side hook that tracks a new connection (reserved for future per-IP metrics).
Reset	Clears the state, rolling-window counters and last-success payload for a single key.
ResetAll	Clears every tracked circuit, every rolling-window counter and all aggregate Metrics.
SaveStateToFile	Persists every tracked circuit's state and counters to a file so they survive a restart.
UnregisterConnection	Server-side hook that stops tracking a disconnected connection (counterpart of RegisterConnection).