ภาษา

IStreamingResponse.SendStreamTimedOutNotification Method

Definition

Cancels the stream and sends a final message to the client indicating that the stream was cancelled, but does not stop the underlying operation. This is useful for long-running operations that may be cancelled by the user or timeout, but should continue to run in the background.

public System.Threading.Tasks.Task<bool> SendStreamTimedOutNotification(string Message, System.Threading.CancellationToken cancellationToken = default);
abstract member SendStreamTimedOutNotification : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
Public Function SendStreamTimedOutNotification (Message As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)

Parameters

Message
String

Message that will be sent to the client indicating the stream was cancelled.

cancellationToken
CancellationToken

Returns

True if the stream was successfully cancelled, false otherwise.

Applies to