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 使子进程能够连接到父进程并与父进程交换信息。

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

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

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

在 Windows 上,匿名管道不支持异步 (重叠) 读取和写入操作, (查看 https://docs.microsoft.com/en-us/windows/win32/ipc/anonymous-pipe-operations) 。 类 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)

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

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

配置如何执行从异步可处置项返回的任务的等待。

适用于