PipeStream 類別

定義

命名空間:

System.IO.Pipes

組件:

System.IO.Pipes.dll

來源:

PipeStream.cs

公開管道的 Stream 物件，其兼具匿名與具名管道的支援。

public ref class PipeStream abstract : System::IO::Stream

public abstract class PipeStream : System.IO.Stream

type PipeStream = class
    inherit Stream

Public MustInherit Class PipeStream
Inherits 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)	使用指定的 PipeStream、PipeDirection 和緩衝區大小，初始化 PipeTransmissionMode 類別的新執行個體。

屬性

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 使用的不受控資源。 (繼承來源 Stream)
EndRead(IAsyncResult)	結束擱置的非同步讀取要求。
EndWrite(IAsyncResult)	結束暫止的非同步寫入要求。
Equals(Object)	判斷指定的物件是否等於目前的物件。 (繼承來源 Object)
Flush()	清除目前資料流的緩衝區，並讓所有的緩衝資料全部寫入基礎裝置。
FlushAsync()	以非同步的方式清除這個資料流的所有緩衝區，並造成所有緩衝資料都寫入基礎裝置。 (繼承來源 Stream)
FlushAsync(CancellationToken)	以非同步方式清除目前資料流的緩衝區，並讓所有的緩衝資料全部寫入底層裝置。
GetHashCode()	做為預設雜湊函式。 (繼承來源 Object)
GetLifetimeService()	已淘汰. 擷取控制這個執行個體存留期 (Lifetime) 原則的目前存留期服務物件。 (繼承來源 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)	將位元組寫入目前的資料流。

擴充方法

GetAccessControl(PipeStream)	傳回管道串流的安全性資訊。
SetAccessControl(PipeStream, PipeSecurity)	變更現有管道串流的安全性屬性。
ConfigureAwait(IAsyncDisposable, Boolean)	設定如何執行從非同步可處置項目傳回的工作 await。