CircuitHandler Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Components.Server.Circuits

Assembly:: Microsoft.AspNetCore.Components.Server.dll

Package:: Microsoft.AspNetCore.App.Ref v3.0.1

Package:: Microsoft.AspNetCore.App.Ref v3.1.10

Package:: Microsoft.AspNetCore.App.Ref v5.0.0

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.0-preview.5.22303.8

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A CircuitHandler allows running code during specific lifetime events of a Circuit.

public ref class CircuitHandler abstract

public abstract class CircuitHandler

type CircuitHandler = class

Public MustInherit Class CircuitHandler

Inheritance: Object
CircuitHandler

Constructors

CircuitHandler()

Properties

Order

Gets the execution order for the current instance of CircuitHandler.

When multiple CircuitHandler instances are registered, the Order property is used to determine the order in which instances are executed. When two handlers have the same value for Order, their execution order is non-deterministic.

Methods

OnCircuitClosedAsync(Circuit, CancellationToken)	Invoked when a new circuit is being discarded.
OnCircuitOpenedAsync(Circuit, CancellationToken)	Invoked when a new circuit was established.
OnConnectionDownAsync(Circuit, CancellationToken)	Invoked when a connection to the client was dropped.
OnConnectionUpAsync(Circuit, CancellationToken)	Invoked when a connection to the client was established. This method is executed once initially after OnCircuitOpenedAsync(Circuit, CancellationToken) and once each for each reconnect during the lifetime of a circuit.

Applies to