AnonymousPipeClientStream 类

定义

公开匿名管道流的客户端,该流支持同步和异步读取和写入操作(在 Windows 平台上不受取消支持)。

public ref class AnonymousPipeClientStream sealed : System::IO::Pipes::PipeStream
public sealed class AnonymousPipeClientStream : System.IO.Pipes.PipeStream
type AnonymousPipeClientStream = class
    inherit PipeStream
Public NotInheritable Class AnonymousPipeClientStream
Inherits PipeStream
继承
AnonymousPipeClientStream
继承
AnonymousPipeClientStream

示例

以下示例使用匿名管道将父进程中的字符串发送到子进程。 此示例在父进程中创建一个 AnonymousPipeServerStream 对象,其 PipeDirection 值为 Out。它还在子进程中创建一个 AnonymousPipeClientStream 对象,其 PipeDirection 值为 In。 然后,父进程将用户提供的字符串发送到子进程。 字符串会显示到控制台。

此示例适用于由服务器进程启动的客户端进程。 将生成的可执行文件命名为客户端代码 pipeClient.exe,并在运行此示例时将其复制到与服务器可执行文件相同的目录。 有关整个代码示例(包括管道客户端和服务器的代码)请参阅 如何:使用匿名管道进行本地进程间通信

//<snippet01>
#using <System.Core.dll>

using namespace System;
using namespace System::IO;
using namespace System::IO::Pipes;

ref class PipeClient
{
public:
    static void Main(array<String^>^ args)
    {
        if (args->Length > 1)
        {
            PipeStream^ pipeClient = gcnew AnonymousPipeClientStream(PipeDirection::In, args[1]);

            Console::WriteLine("[CLIENT] Current TransmissionMode: {0}.",
                pipeClient->TransmissionMode);

            StreamReader^ sr = gcnew StreamReader(pipeClient);

            // Display the read text to the console
            String^ temp;

            // Wait for 'sync message' from the server.
            do
            {
                Console::WriteLine("[CLIENT] Wait for sync...");
                temp = sr->ReadLine();
            }
            while (!temp->StartsWith("SYNC"));

            // Read the server data and echo to the console.
            while ((temp = sr->ReadLine()) != nullptr)
            {
                Console::WriteLine("[CLIENT] Echo: " + temp);
            }
            sr->Close();
            pipeClient->Close();
        }
        Console::Write("[CLIENT] Press Enter to continue...");
        Console::ReadLine();
    }
};

int main()
{
    array<String^>^ args = Environment::GetCommandLineArgs();
    PipeClient::Main(args);
}
//</snippet01>
//<snippet01>
using System;
using System.IO;
using System.IO.Pipes;

class PipeClient
{
    static void Main(string[] args)
    {
        if (args.Length > 0)
        {
            using (PipeStream pipeClient =
                new AnonymousPipeClientStream(PipeDirection.In, args[0]))
            {
                Console.WriteLine("[CLIENT] Current TransmissionMode: {0}.",
                   pipeClient.TransmissionMode);

                using (StreamReader sr = new StreamReader(pipeClient))
                {
                    // Display the read text to the console
                    string temp;

                    // Wait for 'sync message' from the server.
                    do
                    {
                        Console.WriteLine("[CLIENT] Wait for sync...");
                        temp = sr.ReadLine();
                    }
                    while (!temp.StartsWith("SYNC"));

                    // Read the server data and echo to the console.
                    while ((temp = sr.ReadLine()) != null)
                    {
                        Console.WriteLine("[CLIENT] Echo: " + temp);
                    }
                }
            }
        }
        Console.Write("[CLIENT] Press Enter to continue...");
        Console.ReadLine();
    }
}
//</snippet01>
'<snippet01>
Imports System.IO
Imports System.IO.Pipes

Class PipeClient
    Shared Sub Main(args() as String)
        If args.Length > 0 Then
            Using pipeClient As New AnonymousPipeClientStream(PipeDirection.In, args(0))
                Console.WriteLine("[CLIENT] Current TransmissionMode: {0}.", _
                   pipeClient.TransmissionMode)

                Using sr As New StreamReader(pipeClient)
                    ' Display the read text to the console
                    Dim temp As String

                    ' Wait for 'sync message' from the server.
                    Do
                        Console.WriteLine("[CLIENT] Wait for sync...")
                        temp = sr.ReadLine()
                    Loop While temp.StartsWith("SYNC") = False

                    ' Read the server data and echo to the console.
                    temp = sr.ReadLine()
                    While Not temp = Nothing
                        Console.WriteLine("[CLIENT] Echo: " + temp)
                        temp = sr.ReadLine()
                    End While
                End Using
            End Using
        End If
        Console.Write("[CLIENT] Press Enter to continue...")
        Console.ReadLine()
    End Sub
End Class
'</snippet01>

注解

匿名管道有助于在子进程和父进程之间提供安全可靠的进程间通信。 AnonymousPipeClientStream 类使子进程能够连接到父进程并与父进程交换信息。

匿名管道是未命名的单向管道,通常在父进程和子进程之间传输数据。 匿名管道始终是本地管道;不能通过网络使用它们。 不支持 InOutPipeDirection 值,因为匿名管道定义为单向管道。

匿名管道不支持 PipeTransmissionMode.Message 读取模式。

匿名管道的客户端必须通过调用 GetClientHandleAsString 方法从服务器端提供的管道句柄创建。 然后,在创建客户端进程时将字符串作为参数传递。 在客户端进程中,它将作为 pipeHandleAsString 参数传递给 AnonymousPipeClientStream 构造函数。

在 Windows 上,匿名管道不支持异步(重叠)读取和写入操作(请参阅 匿名管道操作)。 AnonymousPipeClientStream 类仍将在 Windows 平台上的线程池上安排工作,因此异步 Stream 操作有效,但不支持取消这些操作。

构造函数

AnonymousPipeClientStream(PipeDirection, SafePipeHandle)

从指定的句柄初始化 AnonymousPipeClientStream 类的新实例。

AnonymousPipeClientStream(PipeDirection, String)

使用指定的管道方向和管道句柄的字符串表示形式初始化 AnonymousPipeClientStream 类的新实例。

AnonymousPipeClientStream(String)

使用管道句柄的指定字符串表示形式初始化 AnonymousPipeClientStream 类的新实例。

属性

CanRead

获取一个值,该值指示当前流是否支持读取操作。

(继承自 PipeStream)
CanSeek

获取一个值,该值指示当前流是否支持查找操作。

(继承自 PipeStream)
CanTimeout

获取一个值,该值确定当前流是否可以超时。

(继承自 Stream)
CanWrite

获取一个值,该值指示当前流是否支持写入操作。

(继承自 PipeStream)
InBufferSize

获取管道的入站缓冲区的大小(以字节为单位)。

(继承自 PipeStream)
IsAsync

获取一个值,该值指示 PipeStream 对象是异步打开还是同步打开。

(继承自 PipeStream)
IsConnected

获取或设置一个值,该值指示 PipeStream 对象是否已连接。

(继承自 PipeStream)
IsHandleExposed

获取一个值,该值指示是否公开 PipeStream 对象的句柄。

(继承自 PipeStream)
IsMessageComplete

获取一个值,该值指示从最近的读取操作返回的消息中是否有更多数据。

(继承自 PipeStream)
Length

获取流的长度(以字节为单位)。

(继承自 PipeStream)
OutBufferSize

获取管道的出站缓冲区的大小(以字节为单位)。

(继承自 PipeStream)
Position

获取或设置当前流的当前位置。

(继承自 PipeStream)
ReadMode

设置 AnonymousPipeClientStream 对象的读取模式。

ReadTimeout

获取或设置一个值(以毫秒为单位),该值确定流在超时前尝试读取的时间。

(继承自 Stream)
SafePipeHandle

获取当前 PipeStream 对象封装的管道的本地端的安全句柄。

(继承自 PipeStream)
TransmissionMode

获取当前管道支持的管道传输模式。

WriteTimeout

获取或设置一个值(以毫秒为单位),该值确定流在超时之前尝试写入的时间。

(继承自 Stream)

方法

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)

开始异步读取操作。

(继承自 PipeStream)
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)

开始异步写入操作。

(继承自 PipeStream)
CheckPipePropertyOperations()

验证管道是否处于正确的状态以获取或设置属性。

(继承自 PipeStream)
CheckReadOperations()

验证管道是否处于已连接状态进行读取操作。

(继承自 PipeStream)
CheckWriteOperations()

验证管道是否处于写入操作的连接状态。

(继承自 PipeStream)
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)

创建一个对象,其中包含生成用于与远程对象通信的代理所需的所有相关信息。

(继承自 MarshalByRefObject)
CreateWaitHandle()
已过时.
已过时.
已过时.

分配 WaitHandle 对象。

(继承自 Stream)
Dispose()

释放 Stream使用的所有资源。

(继承自 Stream)
Dispose(Boolean)

释放 PipeStream 类使用的非托管资源,并选择性地释放托管资源。

(继承自 PipeStream)
DisposeAsync()

异步释放 Stream使用的非托管资源。

(继承自 Stream)
EndRead(IAsyncResult)

结束挂起的异步读取请求。

(继承自 PipeStream)
EndWrite(IAsyncResult)

结束挂起的异步写入请求。

(继承自 PipeStream)
Equals(Object)

确定指定的对象是否等于当前对象。

(继承自 Object)
Finalize()

释放非托管资源,并在垃圾回收回收 AnonymousPipeClientStream 实例之前执行其他清理操作。

Flush()

清除当前流的缓冲区,并导致任何缓冲数据写入基础设备。

(继承自 PipeStream)
FlushAsync()

异步清除此流的所有缓冲区,并导致任何缓冲数据写入基础设备。

(继承自 Stream)
FlushAsync(CancellationToken)

异步清除当前流的缓冲区,并导致任何缓冲数据写入基础设备。

(继承自 PipeStream)
GetAccessControl()

获取一个 PipeSecurity 对象,该对象封装当前 PipeStream 对象描述的管道的访问控制列表(ACL)条目。

(继承自 PipeStream)
GetHashCode()

用作默认哈希函数。

(继承自 Object)
GetLifetimeService()
已过时.

检索控制此实例的生存期策略的当前生存期服务对象。

(继承自 MarshalByRefObject)
GetType()

获取当前实例的 Type

(继承自 Object)
InitializeHandle(SafePipeHandle, Boolean, Boolean)

从指定的 SafePipeHandle 对象初始化 PipeStream 对象。

(继承自 PipeStream)
InitializeLifetimeService()
已过时.

获取生存期服务对象来控制此实例的生存期策略。

(继承自 MarshalByRefObject)
MemberwiseClone()

创建当前 Object的浅表副本。

(继承自 Object)
MemberwiseClone(Boolean)

创建当前 MarshalByRefObject 对象的浅表副本。

(继承自 MarshalByRefObject)
ObjectInvariant()
已过时.

Contract提供支持。

(继承自 Stream)
Read(Byte[], Int32, Int32)

从流中读取字节块,并将数据写入指定缓冲区,从指定长度的指定位置开始。

(继承自 PipeStream)
Read(Span<Byte>)

从当前流中读取字节序列,将其写入字节数组,并通过读取的字节数推进流中的位置。

(继承自 PipeStream)
ReadAsync(Byte[], Int32, Int32)

从当前流异步读取字节序列,并通过读取的字节数推进流中的位置。

(继承自 Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)

将当前流中的字节序列异步读取到从指定字节数开始的字节数组,按读取的字节数推进流中的位置,并监视取消请求。

(继承自 PipeStream)
ReadAsync(Memory<Byte>, CancellationToken)

从当前流异步读取字节序列,将其写入字节内存范围,按读取的字节数推进流中的位置,并监视取消请求。

(继承自 PipeStream)
ReadAtLeast(Span<Byte>, Int32, Boolean)

至少从当前流中读取最小字节数,并通过读取的字节数提升流中的位置。

(继承自 Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)

异步读取当前流的最小字节数,按读取的字节数推进流中的位置,并监视取消请求。

(继承自 Stream)
ReadByte()

从管道读取字节。

(继承自 PipeStream)
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)

将当前流的当前位置设置为指定值。

(继承自 PipeStream)
SetAccessControl(PipeSecurity)

PipeSecurity 对象指定的访问控制列表(ACL)条目应用于当前 PipeStream 对象指定的管道。

(继承自 PipeStream)
SetLength(Int64)

将当前流的长度设置为指定值。

(继承自 PipeStream)
ToString()

返回一个表示当前对象的字符串。

(继承自 Object)
WaitForPipeDrain()

等待管道的另一端读取所有发送的字节。

(继承自 PipeStream)
Write(Byte[], Int32, Int32)

使用缓冲区中的数据将字节块写入当前流。

(继承自 PipeStream)
Write(ReadOnlySpan<Byte>)

将字节序列写入当前流,并通过写入的字节数推进此流中的当前位置。

(继承自 PipeStream)
WriteAsync(Byte[], Int32, Int32)

以异步方式将字节序列写入当前流,并通过写入的字节数推进此流中的当前位置。

(继承自 Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)

从从指定位置开始的字节数组异步写入指定的字节数,按写入的字节数推进此流中的当前位置,并监视取消请求。

(继承自 PipeStream)
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

将字节序列异步写入当前流,按写入的字节数推进此流中的当前位置,并监视取消请求。

(继承自 PipeStream)
WriteByte(Byte)

将字节写入当前流。

(继承自 PipeStream)

扩展方法

CopyToAsync(Stream, PipeWriter, CancellationToken)

使用取消令牌从 Stream 异步读取字节并将其写入指定的 PipeWriter

GetAccessControl(PipeStream)

返回管道流的安全信息。

SetAccessControl(PipeStream, PipeSecurity)

更改现有管道流的安全属性。

ConfigureAwait(IAsyncDisposable, Boolean)

配置如何执行从异步可释放项返回的任务的 await。

适用于