PipeStream.WriteAsync Metoda

  • Reference

Definice

Obor názvů:
System.IO.Pipes
Sestavení:
System.IO.Pipes.dll
Sestavení:
netstandard.dll

Přetížení

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Asynchronně zapíše sekvenci bajtů do aktuálního datového proudu, posune aktuální pozici v rámci tohoto datového proudu o počet zapsaných bajtů a sleduje požadavky na zrušení.
WriteAsync(Byte[], Int32, Int32, CancellationToken)

Asynchronně zapíše zadaný počet bajtů z bajtového pole počínaje zadanou pozicí, posune aktuální pozici v rámci tohoto datového proudu o počet zapsaných bajtů a sleduje požadavky zrušení.

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Zdroj:
PipeStream.Unix.cs
Zdroj:
PipeStream.Unix.cs
Zdroj:
PipeStream.Unix.cs

Asynchronně zapíše sekvenci bajtů do aktuálního datového proudu, posune aktuální pozici v rámci tohoto datového proudu o počet zapsaných bajtů a sleduje požadavky na zrušení.

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

Parametry

buffer
ReadOnlyMemory<Byte>

Oblast paměti, ze které se mají zapisovat data.

cancellationToken
CancellationToken

Token, který se má monitorovat pro žádosti o zrušení. Výchozí hodnota je None.

Návraty

ValueTask

Úloha, která představuje asynchronní operaci zápisu.

Výjimky

NotSupportedException

Stream nepodporuje psaní.

ObjectDisposedException

Nelze získat přístup k uzavřenému kanálu.

IOException

Potrubí je rozbité.

InvalidOperationException

Kanál ještě není připojený.

-nebo-

Kanál je v odpojeném stavu.

-nebo-

Úchyt potrubí nebyl nastaven. (Volala InitializeHandle(SafePipeHandle, Boolean, Boolean)vaše PipeStream implementace ?

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka se uloží do vrácené úlohy.

Poznámky

Metoda WriteAsync umožňuje provádět vstupně-výstupní operace náročné na prostředky bez blokování hlavního vlákna. Tento faktor výkonu je zvlášť důležitý v aplikacích, kde časově náročná operace streamu může blokovat vlákno uživatelského rozhraní a aplikace vypadat, jako by nefungovala. Asynchronní metody se používají ve spojení s klíčovými async slovy a await v jazyce Visual Basic a C#.

CanWrite Pomocí vlastnosti určete, zda aktuální instance podporuje zápis.

Pokud je operace zrušena před dokončením, bude vrácená úloha obsahovat Canceled hodnotu vlastnosti Status .

Platí pro

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

Zdroj:
PipeStream.Unix.cs
Zdroj:
PipeStream.Unix.cs
Zdroj:
PipeStream.Unix.cs

Asynchronně zapíše zadaný počet bajtů z bajtového pole počínaje zadanou pozicí, posune aktuální pozici v rámci tohoto datového proudu o počet zapsaných bajtů a sleduje požadavky zrušení.

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

Parametry

buffer
Byte[]

Vyrovnávací paměť pro zápis dat.

offset
Int32

Posun buffer bajtů založený na nule, ze kterého se má začít kopírovat bajty do datového proudu.

count
Int32

Maximální počet bajtů k zápisu.

cancellationToken
CancellationToken

Token, který se má monitorovat pro žádosti o zrušení. Výchozí hodnota je None.

Návraty

Task

Úloha, která představuje asynchronní operaci zápisu.

Výjimky

ArgumentNullException

buffer je null.

ArgumentOutOfRangeException

Hodnota offset je záporná.

-nebo-

Hodnota count je záporná.

ArgumentException

buffer. Délka – offset je menší než count.

NotSupportedException

Stream nepodporuje psaní.

ObjectDisposedException

Nelze získat přístup k uzavřenému kanálu.

IOException

Potrubí je rozbité.

InvalidOperationException

Kanál ještě není připojený.

-nebo-

Kanál je v odpojeném stavu.

-nebo-

Úchyt potrubí nebyl nastaven. (Volala InitializeHandle(SafePipeHandle, Boolean, Boolean)vaše PipeStream implementace ?

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka se uloží do vrácené úlohy.

Poznámky

Metoda WriteAsync umožňuje provádět vstupně-výstupní operace náročné na prostředky bez blokování hlavního vlákna. Tento faktor výkonu je zvlášť důležitý v aplikacích, kde časově náročná operace streamu může blokovat vlákno uživatelského rozhraní a aplikace vypadat, jako by nefungovala. Asynchronní metody se používají ve spojení s klíčovými async slovy a await v jazyce Visual Basic a C#.

CanWrite Pomocí vlastnosti určete, zda aktuální instance podporuje zápis.

Pokud je operace zrušena před dokončením, bude vrácená úloha obsahovat TaskStatus.Canceled hodnotu vlastnosti Status .

Tato metoda ukládá do úlohy, která vrací všechny výjimky nepouužování, které může vyvolat synchronní protějšek metody. Pokud je do vrácené úlohy uložena výjimka, bude tato výjimka vyvolána, když je úloha očekávána. Výjimky použití, jako ArgumentExceptionje , se stále vyvolává synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem Write(Byte[], Int32, Int32).

Platí pro