PipeStream.WriteAsync Metodo

Definizione

Spazio dei nomi:

System.IO.Pipes

Assembly:

System.IO.Pipes.dll

Overload

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Scrive in modo asincrono una sequenza di byte nel flusso corrente e passa alla posizione successiva all'interno del flusso corrente in base al numero di byte scritti e monitora le richieste di annullamento.
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Scrive in modo asincrono un numero specificato di byte da una matrice di byte che inizia in una posizione specificata, fa avanzare la posizione corrente all'interno del flusso in base al numero di byte scritti e monitora le richieste di annullamento.

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Origine:

PipeStream.Unix.cs

Scrive in modo asincrono una sequenza di byte nel flusso corrente e passa alla posizione successiva all'interno del flusso corrente in base al numero di byte scritti e monitora le richieste di annullamento.

public override System.Threading.Tasks.ValueTask WriteAsync (ReadOnlyMemory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);

override this.WriteAsync : ReadOnlyMemory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

Public Overrides Function WriteAsync (buffer As ReadOnlyMemory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask

Parametri

buffer

ReadOnlyMemory<Byte>

L'area di memoria da cui scrivere i dati.

cancellationToken

CancellationToken

Token da monitorare per le richieste di annullamento. Il valore predefinito è None.

Restituisce

ValueTask

Attività che rappresenta l'operazione di scrittura asincrona.

Eccezioni

NotSupportedException

Il flusso non supporta la scrittura.

ObjectDisposedException

Impossibile accedere a una pipe chiusa.

IOException

Pipe interrotta.

InvalidOperationException

Pipe non ancora connessa.

-oppure-

Pipe in stato disconnesso.

-oppure-

L'handle di pipe non è stato impostato. Verificare se l'implementazione PipeStream ha chiamato InitializeHandle(SafePipeHandle, Boolean, Boolean).

OperationCanceledException

Il token di annullamento è stato annullato. Questa eccezione viene archiviata nell'attività restituita.

Commenti

Il WriteAsync metodo consente di eseguire operazioni di I/O a elevato utilizzo di risorse senza bloccare il thread principale. Questa considerazione sulle prestazioni è particolarmente importante nelle applicazioni in cui un'operazione di flusso che richiede tempo può bloccare il thread dell'interfaccia utente e rendere l'app come se non funziona. I metodi asincroni vengono usati insieme alle async parole chiave e await in Visual Basic e C#.

Utilizzare la proprietà per determinare se l'istanza corrente supporta la CanWrite scrittura.

Se l'operazione viene annullata prima del completamento, l'attività restituita contiene il Canceled valore della Status proprietà.

WriteAsync(Byte[], Int32, Int32, CancellationToken)

Origine:

PipeStream.Unix.cs

Scrive in modo asincrono un numero specificato di byte da una matrice di byte che inizia in una posizione specificata, fa avanzare la posizione corrente all'interno del flusso in base al numero di byte scritti e monitora le richieste di annullamento.

public:
 override System::Threading::Tasks::Task ^ WriteAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task WriteAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

override this.WriteAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overrides Function WriteAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task

Parametri

buffer

Byte[]

Buffer da cui scrivere i dati.

offset

Int32

Offset dei byte in base zero in buffer da cui iniziare la copia dei byte nel flusso.

count

Int32

Numero massimo di byte da scrivere.

cancellationToken

CancellationToken

Token da monitorare per le richieste di annullamento. Il valore predefinito è None.

Restituisce

Task

Attività che rappresenta l'operazione di scrittura asincrona.

Eccezioni

ArgumentNullException

buffer è null.

ArgumentOutOfRangeException

offset è negativo.

-oppure-

count è negativo.

ArgumentException

buffer.Length - offset è minore di count.

NotSupportedException

Il flusso non supporta la scrittura.

ObjectDisposedException

Impossibile accedere a una pipe chiusa.

IOException

Pipe interrotta.

InvalidOperationException

Pipe non ancora connessa.

-oppure-

Pipe in stato disconnesso.

-oppure-

L'handle di pipe non è stato impostato. Verificare se l'implementazione PipeStream ha chiamato InitializeHandle(SafePipeHandle, Boolean, Boolean).

OperationCanceledException

Il token di annullamento è stato annullato. Questa eccezione viene archiviata nell'attività restituita.

Commenti

Il WriteAsync metodo consente di eseguire operazioni di I/O a elevato utilizzo di risorse senza bloccare il thread principale. Questa considerazione sulle prestazioni è particolarmente importante nelle applicazioni in cui un'operazione di flusso che richiede tempo può bloccare il thread dell'interfaccia utente e rendere l'app come se non funziona. I metodi asincroni vengono usati insieme alle async parole chiave e await in Visual Basic e C#.

Utilizzare la proprietà per determinare se l'istanza corrente supporta la CanWrite scrittura.

Se l'operazione viene annullata prima del completamento, l'attività restituita contiene il TaskStatus.Canceled valore della Status proprietà.

Questo metodo archivia nell'attività che restituisce tutte le eccezioni non di utilizzo che la controparte sincrona del metodo può generare. Se un'eccezione viene archiviata nell'attività restituita, tale eccezione verrà generata quando l'attività è attesa. Le eccezioni di utilizzo, ad esempio ArgumentException, vengono comunque generate in modo sincrono. Per le eccezioni archiviate, vedere le eccezioni generate da Write(Byte[], Int32, Int32).