PipeStream.ReadAsync Metode

Definisi

Ruang nama:

System.IO.Pipes

Rakitan:

System.IO.Pipes.dll

Overload

ReadAsync(Memory<Byte>, CancellationToken)	Secara asinkron membaca urutan byte dari aliran saat ini, menulisnya ke rentang memori byte, memajukan posisi dalam aliran dengan jumlah byte yang dibaca, dan memantau permintaan pembatalan.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Secara asinkron membaca urutan byte dari aliran saat ini ke array byte yang dimulai pada posisi tertentu untuk jumlah byte tertentu, memajukan posisi dalam aliran dengan jumlah byte yang dibaca, dan memantau permintaan pembatalan.

ReadAsync(Memory<Byte>, CancellationToken)

Sumber:

PipeStream.Unix.cs

Secara asinkron membaca urutan byte dari aliran saat ini, menulisnya ke rentang memori byte, memajukan posisi dalam aliran dengan jumlah byte yang dibaca, dan memantau permintaan pembatalan.

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)

Parameter

buffer

Memory<Byte>

Wilayah memori untuk menulis data.

cancellationToken

CancellationToken

Token yang akan dipantau untuk permintaan pembatalan. Nilai defaultnya adalah None.

Mengembalikan

ValueTask<Int32>

Tugas yang mewakili operasi baca asinkron. Nilai propertinya Result berisi jumlah total byte yang dibaca ke dalam buffer. Nilai hasil dapat kurang dari jumlah byte yang dialokasikan dalam buffer jika banyak byte saat ini tidak tersedia, atau bisa 0 (nol) jika akhir aliran telah tercapai.

Pengecualian

NotSupportedException

Aliran tidak mendukung pembacaan.

ObjectDisposedException

Tidak dapat mengakses pipa tertutup.

InvalidOperationException

Pipa belum tersambung.

-atau-

Pipa dalam keadaan terputus.

-atau-

Handel pipa belum disetel. (Apakah implementasi Anda PipeStream memanggil InitializeHandle(SafePipeHandle, Boolean, Boolean)?

OperationCanceledException

Token pembatalan dibatalkan. Pengecualian ini disimpan ke dalam tugas yang dikembalikan.

Keterangan

Metode ini ReadAsync memungkinkan Anda melakukan operasi I/O intensif sumber daya tanpa memblokir utas utama. Pertimbangan performa ini sangat penting dalam aplikasi di mana operasi streaming yang memakan waktu dapat memblokir utas UI dan membuat aplikasi Anda muncul seolah-olah tidak berfungsi. Metode asinkron digunakan bersama dengan async kata kunci dan await di Visual Basic dan C#.

CanRead Gunakan properti untuk menentukan apakah instans saat ini mendukung pembacaan.

Jika operasi dibatalkan sebelum selesai, tugas yang dikembalikan berisi TaskStatus.Canceled nilai untuk Status properti .

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

Sumber:

PipeStream.Unix.cs

Secara asinkron membaca urutan byte dari aliran saat ini ke array byte yang dimulai pada posisi tertentu untuk jumlah byte tertentu, memajukan posisi dalam aliran dengan jumlah byte yang dibaca, dan memantau permintaan pembatalan.

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)

Parameter

buffer

Byte[]

Buffer untuk menulis data ke dalamnya.

offset

Int32

Offset byte untuk buffer mulai menulis data dari aliran.

count

Int32

Jumlah maksimum byte yang akan dibaca.

cancellationToken

CancellationToken

Token yang akan dipantau untuk permintaan pembatalan. Nilai defaultnya adalah None.

Mengembalikan

Task<Int32>

Tugas yang mewakili operasi baca asinkron. Nilai propertinya Result berisi jumlah total byte yang dibaca ke dalam buffer. Nilai hasilnya bisa kurang dari jumlah byte yang diminta jika jumlah byte yang saat ini tersedia kurang dari angka yang diminta, atau bisa 0 (nol) jika akhir aliran telah tercapai.

Pengecualian

NotSupportedException

Aliran tidak mendukung pembacaan.

ObjectDisposedException

Tidak dapat mengakses pipa tertutup.

InvalidOperationException

Pipa belum tersambung.

-atau-

Pipa dalam keadaan terputus.

-atau-

Handel pipa belum disetel. (Apakah implementasi Anda PipeStream memanggil InitializeHandle(SafePipeHandle, Boolean, Boolean)?

OperationCanceledException

Token pembatalan dibatalkan. Pengecualian ini disimpan ke dalam tugas yang dikembalikan.

Keterangan

Metode ini ReadAsync memungkinkan Anda melakukan operasi I/O intensif sumber daya tanpa memblokir utas utama. Pertimbangan performa ini sangat penting dalam aplikasi di mana operasi streaming yang memakan waktu dapat memblokir utas UI dan membuat aplikasi Anda muncul seolah-olah tidak berfungsi. Metode asinkron digunakan bersama dengan async kata kunci dan await di Visual Basic dan C#.

CanRead Gunakan properti untuk menentukan apakah instans saat ini mendukung pembacaan.

Jika operasi dibatalkan sebelum selesai, tugas yang dikembalikan berisi TaskStatus.Canceled nilai untuk Status properti .

Metode ini disimpan dalam tugas yang menampilkan semua pengecualian non-penggunaan yang dapat dilemparkan oleh rekan sinkron metode. Jika pengecualian disimpan ke dalam tugas yang dikembalikan, pengecualian tersebut akan dilemparkan saat tugas ditunggu. Pengecualian penggunaan, seperti ArgumentException, masih dilemparkan secara sinkron. Untuk pengecualian yang disimpan, lihat pengecualian yang dilemparkan oleh Read(Byte[], Int32, Int32).