CircuitOptions Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Components.Server

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.5

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

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.

Options to configure circuit handler for server-side Blazor

public ref class CircuitOptions sealed

public sealed class CircuitOptions

type CircuitOptions = class

Public NotInheritable Class CircuitOptions

Inheritance: Object
CircuitOptions

Constructors

CircuitOptions()

Properties

DetailedErrors	Gets or sets a value that determines whether or not to send detailed exception messages to JavaScript when an unhandled exception happens on the circuit or when a .NET method invocation through JS interop results in an exception.
DisconnectedCircuitMaxRetained	Gets or sets a value that determines the maximum number of disconnected circuit state details are retained by the server. When a client disconnects, ASP.NET Core Components attempts to retain state on the server for an interval. This allows the client to re-establish a connection to the existing circuit on the server without losing any state in the event of transient connection issues. This value determines the maximum number of circuit states retained by the server.
DisconnectedCircuitRetentionPeriod	Gets or sets a value that determines the maximum duration state for a disconnected circuit is retained on the server. When a client disconnects, ASP.NET Core Components attempts to retain state on the server for an interval. This allows the client to re-establish a connection to the existing circuit on the server without losing any state in the event of transient connection issues. This value determines the maximum duration circuit state is retained by the server before being evicted.
JSInteropDefaultCallTimeout	Gets or sets a value that indicates how long the server will wait before timing out an asynchronous JavaScript function invocation.
MaxBufferedUnacknowledgedRenderBatches	Gets or sets the maximum number of render batches that a circuit will buffer until an acknowledgement for the batch is received.
RootComponents	Gets options for root components within the circuit.

Applies to