NetworkStream.FlushAsync(CancellationToken) 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.
Flushes data from the stream as an asynchronous operation.
public:
override System::Threading::Tasks::Task ^ FlushAsync(System::Threading::CancellationToken cancellationToken);public override System.Threading.Tasks.Task FlushAsync (System.Threading.CancellationToken cancellationToken);override this.FlushAsync : System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overrides Function FlushAsync (cancellationToken As CancellationToken) As TaskParameters
- cancellationToken
- CancellationToken
A cancellation token used to propagate notification that this operation should be canceled.
Returns
The task object representing the asynchronous operation.
Exceptions
The cancellation token was canceled. This exception is stored into the returned task.
Remarks
This operation will not block. The returned Task object will complete after data has been flushed from the stream for the NetworkStream instance.
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Flush().
