HubOptions<THub> Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.SignalR

Assembly:: Microsoft.AspNetCore.SignalR.Core.dll

Package:: Microsoft.AspNetCore.SignalR.Core v1.0.0

Package:: Microsoft.AspNetCore.SignalR.Core v1.1.0

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

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

Source:: HubOptions%60T.cs

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 used to configure the specified hub type instances. These options override globally set options.

generic <typename THub>
 where THub : Hubpublic ref class HubOptions : Microsoft::AspNetCore::SignalR::HubOptions

public class HubOptions<THub> : Microsoft.AspNetCore.SignalR.HubOptions where THub : Hub

type HubOptions<'Hub (requires 'Hub :> Hub)> = class
    inherit HubOptions

Public Class HubOptions(Of THub)
Inherits HubOptions

Type Parameters

THub

The hub type to configure.

Inheritance: Object

HubOptions
HubOptions<THub>

Constructors

HubOptions<THub>()

Properties

ClientTimeoutInterval	Gets or sets the time window clients have to send a message before the server closes the connection. The default timeout is 30 seconds. (Inherited from HubOptions)
DisableImplicitFromServicesParameters	When `false`, IServiceProviderIsService determines if a Hub method parameter will be injected from the DI container. Parameters can be explicitly marked with an attribute that implements IFromServiceMetadata with or without this option set. (Inherited from HubOptions)
EnableDetailedErrors	Gets or sets a value indicating whether detailed error messages are sent to the client. Detailed error messages include details from exceptions thrown on the server. (Inherited from HubOptions)
HandshakeTimeout	Gets or sets the interval used by the server to timeout incoming handshake requests by clients. The default timeout is 15 seconds. (Inherited from HubOptions)
KeepAliveInterval	Gets or sets the interval used by the server to send keep alive pings to connected clients. The default interval is 15 seconds. (Inherited from HubOptions)
MaximumParallelInvocationsPerClient	By default a client is only allowed to invoke a single Hub method at a time. Changing this property will allow clients to invoke multiple methods at the same time before queueing. (Inherited from HubOptions)
MaximumReceiveMessageSize	Gets or sets the maximum message size of a single incoming hub message. The default is 32KB. (Inherited from HubOptions)
StatefulReconnectBufferSize	Gets or sets the maximum bytes to buffer per connection when using stateful reconnect. (Inherited from HubOptions)
StreamBufferCapacity	Gets or sets the max buffer size for client upload streams. The default size is 10. (Inherited from HubOptions)
SupportedProtocols	Gets or sets a collection of supported hub protocol names. (Inherited from HubOptions)

Extension Methods

AddFilter(HubOptions, IHubFilter)	Adds an instance of an IHubFilter to the HubOptions.
AddFilter(HubOptions, Type)	Adds an IHubFilter type to the HubOptions that will be resolved via DI or type activated.
AddFilter<TFilter>(HubOptions)	Adds an IHubFilter type to the HubOptions that will be resolved via DI or type activated.

Applies to

Share via