PipeStream.ReadAsync Metoda

Definice

Obor názvů:

System.IO.Pipes

Sestavení:

netstandard.dll, System.IO.Pipes.dll

Přetížení

Name	Description
ReadAsync(Memory<Byte>, CancellationToken)	Asynchronně čte posloupnost bajtů z aktuálního datového proudu, zapíše je do bajtového rozsahu paměti, posune pozici v datovém proudu o počet přečtených bajtů a monitoruje požadavky na zrušení.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronně čte posloupnost bajtů z aktuálního datového proudu do bajtového pole počínaje zadanou pozicí pro zadaný počet bajtů, posune pozici v datovém proudu o počet přečtených bajtů a monitoruje žádosti o zrušení.

ReadAsync(Memory<Byte>, CancellationToken)

Zdroj:

PipeStream.Unix.cs

Asynchronně čte posloupnost bajtů z aktuálního datového proudu, zapíše je do bajtového rozsahu paměti, posune pozici v datovém proudu o počet přečtených bajtů a monitoruje požadavky na zrušení.

public override System.Threading.Tasks.ValueTask<int> ReadAsync(Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);

override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Parametry

buffer

Memory<Byte>

Oblast paměti pro zápis dat do.

cancellationToken

CancellationToken

Token pro monitorování žádostí o zrušení. Výchozí hodnota je None.

Návraty

ValueTask<Int32>

Úloha, která představuje asynchronní operaci čtení. Hodnota jeho Result vlastnosti obsahuje celkový počet bajtů přečtených do vyrovnávací paměti. Výsledná hodnota může být menší než počet bajtů přidělených ve vyrovnávací paměti, pokud není aktuálně k dispozici mnoho bajtů, nebo může být 0 (nula), pokud bylo dosaženo konce datového proudu.

Výjimky

NotSupportedException

Stream nepodporuje čtení.

ObjectDisposedException

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

InvalidOperationException

Potrubí ještě nebylo připojeno.

nebo

Kanál je v odpojeném stavu.

nebo

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

OperationCanceledException

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

Poznámky

Tato ReadAsync metoda 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 zobrazit aplikaci, jako by nefungovala. Asynchronní metody se používají ve spojení s async klíčovými await slovy v jazyce Visual Basic a C#.

CanRead Pomocí vlastnosti určete, zda aktuální instance podporuje čtení.

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

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

Zdroj:

PipeStream.Unix.cs

Asynchronně čte posloupnost bajtů z aktuálního datového proudu do bajtového pole počínaje zadanou pozicí pro zadaný počet bajtů, posune pozici v datovém proudu o počet přečtených bajtů a monitoruje žádosti o zrušení.

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

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

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

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

Parametry

buffer

Byte[]

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

offset

Int32

Posun bajtů, při buffer kterém se mají začít zapisovat data z datového proudu.

count

Int32

Maximální počet bajtů, které se mají přečíst.

cancellationToken

CancellationToken

Token pro monitorování žádostí o zrušení. Výchozí hodnota je None.

Návraty

Task<Int32>

Úloha, která představuje asynchronní operaci čtení. Hodnota jeho Result vlastnosti obsahuje celkový počet bajtů přečtených do vyrovnávací paměti. Výsledná hodnota může být menší než počet bajtů požadovaných v případě, že je počet bajtů aktuálně k dispozici menší než požadované číslo, nebo může být 0 (nula), pokud byl dosažen konec datového proudu.

Výjimky

NotSupportedException

Stream nepodporuje čtení.

ObjectDisposedException

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

InvalidOperationException

Potrubí ještě nebylo připojeno.

nebo

Kanál je v odpojeném stavu.

nebo

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

OperationCanceledException

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

Poznámky

Tato ReadAsync metoda 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 zobrazit aplikaci, jako by nefungovala. Asynchronní metody se používají ve spojení s async klíčovými await slovy v jazyce Visual Basic a C#.

CanRead Pomocí vlastnosti určete, zda aktuální instance podporuje čtení.

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

Tato metoda ukládá do úlohy všechny výjimky bez použití, které může vyvolat synchronní protějšek metody. Pokud je výjimka uložena do vrácené úlohy, tato výjimka bude vyvolána, když je úkol očekáván. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. V případě uložených výjimek se podívejte na výjimky vyvolané Read(Byte[], Int32, Int32).