Share via

HubConnectionContext.WriteAsync Method

  • 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

Overloads

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.

WriteAsync(HubMessage, CancellationToken)

Source:
HubConnectionContext.cs
Source:
HubConnectionContext.cs

Write a HubMessage to the connection.

public virtual System.Threading.Tasks.ValueTask WriteAsync (Microsoft.AspNetCore.SignalR.Protocol.HubMessage message, System.Threading.CancellationToken cancellationToken = default);
abstract member WriteAsync : Microsoft.AspNetCore.SignalR.Protocol.HubMessage * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask
override this.WriteAsync : Microsoft.AspNetCore.SignalR.Protocol.HubMessage * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask
Public Overridable Function WriteAsync (message As HubMessage, Optional cancellationToken As CancellationToken = Nothing) As ValueTask

Parameters

message
HubMessage

The HubMessage being written.

cancellationToken
CancellationToken

Cancels the in progress write.

Returns

ValueTask

A ValueTask that represents the completion of the write. If the write throws this task will still complete successfully.

Applies to

WriteAsync(SerializedHubMessage, CancellationToken)

Source:
HubConnectionContext.cs
Source:
HubConnectionContext.cs

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.

public virtual System.Threading.Tasks.ValueTask WriteAsync (Microsoft.AspNetCore.SignalR.SerializedHubMessage message, System.Threading.CancellationToken cancellationToken = default);
abstract member WriteAsync : Microsoft.AspNetCore.SignalR.SerializedHubMessage * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask
override this.WriteAsync : Microsoft.AspNetCore.SignalR.SerializedHubMessage * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask
Public Overridable Function WriteAsync (message As SerializedHubMessage, Optional cancellationToken As CancellationToken = Nothing) As ValueTask

Parameters

message
SerializedHubMessage

The serialization cache to use.

cancellationToken
CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

ValueTask

Applies to