PipeStream 類別

定義

命名空間:

System.IO.Pipes

組件:

System.IO.Pipes.dll

來源:

PipeStream.cs

在管道周圍公開 Stream 物件，該管道同時支援匿名和具名管道。

C#

public abstract class PipeStream : System.IO.Stream

繼承

Object

MarshalByRefObject

Stream

PipeStream

衍生

System.IO.Pipes.AnonymousPipeClientStream

System.IO.Pipes.AnonymousPipeServerStream

System.IO.Pipes.NamedPipeClientStream

System.IO.Pipes.NamedPipeServerStream

備註

PipeStream 類別提供 .NET Framework 中具名和匿名管道作業的基類。 使用命名管道作業的 NamedPipeServerStream 和 NamedPipeClientStream 類別。 使用 AnonymousPipeServerStream 和 AnonymousPipeClientStream 類別進行匿名管道作業。

如需管道的詳細資訊，請參閱 管道。 如需匿名管道的範例，請參閱 如何：使用匿名管道進行本機進程間通訊。 如需命名管道的範例，請參閱 How to： Use Named Pipes for Network Interprocess Communication。

建構函式

PipeStream(PipeDirection, Int32)	使用指定的 PipeDirection 值和緩衝區大小，初始化 PipeStream 類別的新實例。
PipeStream(PipeDirection, PipeTransmissionMode, Int32)	使用指定的 PipeDirection、PipeTransmissionMode和緩衝區大小，初始化 PipeStream 類別的新實例。

屬性

CanRead	取得值，指出目前數據流是否支援讀取作業。
CanSeek	取得值，指出目前數據流是否支持搜尋作業。
CanTimeout	取得值，這個值會判斷目前的數據流是否可以逾時。 (繼承來源 Stream)
CanWrite	取得值，指出目前數據流是否支援寫入作業。
InBufferSize	取得管道輸入緩衝區的大小，以位元組為單位。
IsAsync	取得值，指出 PipeStream 物件是以異步或同步方式開啟。
IsConnected	取得或設定值，指出 PipeStream 物件是否已連接。
IsHandleExposed	取得值，指出是否公開 PipeStream 物件的句柄。
IsMessageComplete	取得值，指出從最近讀取作業傳回的訊息中是否有更多數據。
Length	取得數據流的長度，以位元組為單位。
OutBufferSize	取得管道輸出緩衝區的大小，以位元組為單位。
Position	取得或設定目前數據流的目前位置。
ReadMode	取得或設定 PipeStream 物件的讀取模式。
ReadTimeout	取得或設定值，以毫秒為單位，決定數據流在逾時之前嘗試讀取的時間長度。 (繼承來源 Stream)
SafePipeHandle	取得目前 PipeStream 物件封裝之管道之本機端的安全句柄。
TransmissionMode	取得目前管道支援的管道傳輸模式。
WriteTimeout	取得或設定值，以毫秒為單位，決定數據流在逾時之前嘗試寫入的時間長度。 (繼承來源 Stream)

方法

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	開始異步讀取作業。
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	開始異步寫入作業。
CheckPipePropertyOperations()	確認管道處於取得或設定屬性的適當狀態。
CheckReadOperations()	確認管道處於讀取作業的連線狀態。
CheckWriteOperations()	確認管道處於寫入作業的連線狀態。
Close()	關閉目前的數據流，並釋放與目前數據流相關聯的任何資源（例如套接字和檔句柄）。 請確定已正確處置數據流，而不是呼叫此方法。 (繼承來源 Stream)
CopyTo(Stream)	從目前的數據流讀取位元組，並將其寫入另一個數據流。 這兩個數據流位置都會依複製的位元元組數目進階。 (繼承來源 Stream)
CopyTo(Stream, Int32)	從目前的數據流讀取位元組，並使用指定的緩衝區大小將它們寫入另一個數據流。 這兩個數據流位置都會依複製的位元元組數目進階。 (繼承來源 Stream)
CopyToAsync(Stream)	以異步方式從目前的數據流讀取位元組，並將其寫入另一個數據流。 這兩個數據流位置都會依複製的位元元組數目進階。 (繼承來源 Stream)
CopyToAsync(Stream, CancellationToken)	使用指定的取消標記，以異步方式從目前數據流讀取位元組，並將其寫入另一個數據流。 這兩個數據流位置都會依複製的位元元組數目進階。 (繼承來源 Stream)
CopyToAsync(Stream, Int32)	使用指定的緩衝區大小，以異步方式從目前數據流讀取位元組，並將其寫入另一個數據流。 這兩個數據流位置都會依複製的位元元組數目進階。 (繼承來源 Stream)
CopyToAsync(Stream, Int32, CancellationToken)	使用指定的緩衝區大小和取消標記，以異步方式從目前數據流讀取位元組，並將其寫入另一個數據流。 這兩個數據流位置都會依複製的位元元組數目進階。 (繼承來源 Stream)
CreateObjRef(Type)	建立物件，其中包含產生用來與遠端物件通訊之 Proxy 所需的所有相關信息。 (繼承來源 MarshalByRefObject)
CreateWaitHandle()	已淘汰. 配置 WaitHandle 物件。 (繼承來源 Stream)
Dispose()	釋放 Stream所使用的所有資源。 (繼承來源 Stream)
Dispose(Boolean)	釋放 PipeStream 類別所使用的 Unmanaged 資源，並選擇性地釋放 Managed 資源。
DisposeAsync()	以異步方式釋放 Stream所使用的 Unmanaged 資源。 (繼承來源 Stream)
EndRead(IAsyncResult)	結束暫止的異步讀取要求。
EndWrite(IAsyncResult)	結束暫止的異步寫入要求。
Equals(Object)	判斷指定的物件是否等於目前的物件。 (繼承來源 Object)
Flush()	清除目前數據流的緩衝區，並導致任何緩衝的數據寫入基礎裝置。
FlushAsync()	以異步方式清除此數據流的所有緩衝區，並導致任何緩衝的數據寫入基礎裝置。 (繼承來源 Stream)
FlushAsync(CancellationToken)	以異步方式清除目前數據流的緩衝區，並導致任何緩衝的數據寫入基礎裝置。
GetHashCode()	做為預設哈希函式。 (繼承來源 Object)
GetLifetimeService()	已淘汰. 擷取控制這個實例存留期原則的目前存留期服務物件。 (繼承來源 MarshalByRefObject)
GetType()	取得目前實例的 Type。 (繼承來源 Object)
InitializeHandle(SafePipeHandle, Boolean, Boolean)	從指定的 SafePipeHandle 物件初始化 PipeStream 物件。
InitializeLifetimeService()	已淘汰. 取得存留期服務物件，以控制這個實例的存留期原則。 (繼承來源 MarshalByRefObject)
MemberwiseClone()	建立目前 Object的淺層複本。 (繼承來源 Object)
MemberwiseClone(Boolean)	建立目前 MarshalByRefObject 對象的淺層複本。 (繼承來源 MarshalByRefObject)
ObjectInvariant()	已淘汰. 提供 Contract的支援。 (繼承來源 Stream)
Read(Byte[], Int32, Int32)	從數據流讀取位元組區塊，並將數據寫入指定的緩衝區，從指定長度的指定位置開始。
Read(Span<Byte>)	從目前數據流讀取位元組序列、將它們寫入位元組陣列，並將數據流中的位置依讀取的位元組數目往前移。
ReadAsync(Byte[], Int32, Int32)	以異步方式從目前數據流讀取位元組序列，並依讀取的位元元組數目將數據流中的位置往前移。 (繼承來源 Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	以異步方式將位元組序列從目前數據流讀取至位元組陣列，從指定位元組數目開始的位元組陣列、依讀取的位元組數目將數據流中的位置往前移，並監視取消要求。
ReadAsync(Memory<Byte>, CancellationToken)	以異步方式從目前數據流讀取位元組序列、將它們寫入位元組記憶體範圍、依讀取位元組數目將數據流中的位置往前移，以及監視取消要求。
ReadAtLeast(Span<Byte>, Int32, Boolean)	從目前數據流讀取至少一個字節數目，並將數據流中的位置依讀取的位元組數目往前移。 (繼承來源 Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	以異步方式從目前數據流讀取至少一個字節數目、依讀取的位元組數目將數據流中的位置往前移，並監視取消要求。 (繼承來源 Stream)
ReadByte()	從管道讀取位元組。
ReadExactly(Byte[], Int32, Int32)	從目前數據流讀取 count 位元組數，並將位置往前移。 (繼承來源 Stream)
ReadExactly(Span<Byte>)	從目前的數據流讀取位元組，並將位置往前移，直到填入 buffer 為止。 (繼承來源 Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	以異步方式從目前數據流讀取 count 位元組數目、推進數據流中的位置，以及監視取消要求。 (繼承來源 Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	以異步方式從目前數據流讀取位元組、將數據流中的位置往前移，直到填入 buffer，並監視取消要求。 (繼承來源 Stream)
Seek(Int64, SeekOrigin)	將目前數據流的目前位置設定為指定的值。
SetLength(Int64)	將目前數據流的長度設定為指定的值。
ToString()	傳回表示目前 物件的字串。 (繼承來源 Object)
WaitForPipeDrain()	等候管道的另一端讀取所有傳送的位元組。
Write(Byte[], Int32, Int32)	使用緩衝區中的數據，將位元組區塊寫入目前數據流。
Write(ReadOnlySpan<Byte>)	將位元組序列寫入目前數據流，並依寫入的位元元組數目，將這個數據流中的目前位置往前移。
WriteAsync(Byte[], Int32, Int32)	以異步方式將位元組序列寫入目前數據流，並依寫入的位元元組數目，將這個數據流中的目前位置往前移。 (繼承來源 Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	從位元組陣列從指定位置開始，以異步方式寫入指定的位元組數目、依寫入的位元組數目將這個資料流中的目前位置往前移，並監視取消要求。
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	以異步方式將位元組序列寫入至目前的數據流、依寫入的位元組數目將這個數據流中的目前位置往前移，並監視取消要求。
WriteByte(Byte)	將位元組寫入目前數據流。

擴充方法

CopyToAsync(Stream, PipeWriter, CancellationToken)	使用取消標記，以異步方式從 Stream 讀取位元組，並將其寫入指定的 PipeWriter。
GetAccessControl(PipeStream)	傳回管道數據流的安全性資訊。
SetAccessControl(PipeStream, PipeSecurity)	變更現有管道數據流的安全性屬性。
ConfigureAwait(IAsyncDisposable, Boolean)	設定如何執行從異步可處置專案傳回的工作等候。

適用於