Class SignalRSettings

Typed configuration options for SignalR settings.

Inheritance

object

Namespace: Umbraco.Cms.Core.Configuration.Models

Assembly: Umbraco.Core.dll

Syntax

[UmbracoOptions("Umbraco:CMS:SignalR")]
public class SignalRSettings

Remarks

When ClientShouldSkipNegotiation is enabled, all hub endpoints are restricted to WebSocket transport and the client skips the negotiate round-trip. The setting is forwarded to the client via the /umbraco/management/api/v1/server/configuration endpoint.

Downstream packages (e.g. Umbraco Cloud) can configure these settings via IConfigureOptions<SignalRSettings> or appsettings.json under Umbraco:CMS:SignalR.

Constructors

View Source

SignalRSettings()

Declaration

public SignalRSettings()

Properties

View Source

ClientShouldSkipNegotiation

Gets or sets a value indicating whether the client should skip the SignalR negotiate round-trip and connect directly via WebSockets.

Declaration

public bool ClientShouldSkipNegotiation { get; set; }

Property Value

Type	Description
bool

Remarks

When true, the server restricts all hub endpoints to the WebSocket transport only (via HttpConnectionDispatcherOptions.Transports) and the client is instructed to set skipNegotiation = true with transport = WebSockets. This eliminates the negotiate HTTP request that causes failures in load-balanced deployments without sticky sessions. This is safe for self-hosted SignalR but must not be used with Azure SignalR Service.