HubConnectionContext 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:: HubConnectionContext.cs

Source:: HubConnectionContext.cs

Source:: HubConnectionContext.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.

Encapsulates all information about an individual connection to a SignalR Hub.

public ref class HubConnectionContext

public class HubConnectionContext

type HubConnectionContext = class

Public Class HubConnectionContext

Inheritance: Object
HubConnectionContext

Constructors

HubConnectionContext(ConnectionContext, HubConnectionContextOptions, ILoggerFactory)	Initializes a new instance of the HubConnectionContext class.
HubConnectionContext(ConnectionContext, TimeSpan, ILoggerFactory, TimeSpan)	Initializes a new instance of the HubConnectionContext class.
HubConnectionContext(ConnectionContext, TimeSpan, ILoggerFactory)	Initializes a new instance of the HubConnectionContext class.

Properties

ConnectionAborted	Gets a CancellationToken that notifies when the connection is aborted.
ConnectionId	Gets the ID for this connection.
Features	Gets the collection of features available on this connection.
Items	Gets a key/value collection that can be used to share data within the scope of this connection.
Protocol	Gets the protocol used by this connection.
User	Gets the user for this connection.
UserIdentifier	Gets or sets the user identifier for this connection.

Methods

Abort()	Aborts the connection.
WriteAsync(HubMessage, CancellationToken)	Write a HubMessage to the connection.
WriteAsync(SerializedHubMessage, CancellationToken)	This method is designed to support the framework and is not intended to be used by application code. Writes a pre-serialized message to the connection.

Extension Methods

GetHttpContext(HubConnectionContext)

Gets HttpContext from the specified connection, or null if the connection is not associated with an HTTP request.

Applies to

Product	Versions
ASP.NET Core	2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

Share via