HubConnectionContext.WriteAsync Method
Definition
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.
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
- 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.ValueTaskPublic Overridable Function WriteAsync (message As HubMessage, Optional cancellationToken As CancellationToken = Nothing) As ValueTaskParameters
- message
- HubMessage
The HubMessage being written.
- cancellationToken
- CancellationToken
Cancels the in progress write.
Returns
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
- 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.ValueTaskPublic Overridable Function WriteAsync (message As SerializedHubMessage, Optional cancellationToken As CancellationToken = Nothing) As ValueTaskParameters
- message
- SerializedHubMessage
The serialization cache to use.
- cancellationToken
- CancellationToken
The token to monitor for cancellation requests. The default value is None.