NamedPipeClientStream 类

定义

暴露命名管道周围的 Stream,该管道既支持同步读写操作,也支持异步读写操作。

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

示例

以下示例演示了一种使用命名管道将字符串从父进程发送到同一计算机上的子进程的方法。 此示例在 NamedPipeServerStream 父进程中创建对象。 对象的NamedPipeServerStreamPipeDirection值为 Out。然后,服务器等待NamedPipeClientStream子进程中的对象连接到该对象。 在此示例中,这两个进程位于同一PipeDirection台计算机上,NamedPipeClientStream并且 对象的值为 In。 接下来,父进程将用户提供的字符串发送给子进程。 字符串显示在控制台中。

此示例适用于连接到服务器进程的客户端进程。 有关整个代码示例(包括管道客户端和服务器的代码),请参阅 如何:使用命名管道进行网络进程间通信

using System;
using System.IO;
using System.IO.Pipes;

class PipeClient
{
    static void Main(string[] args)
    {
        using (NamedPipeClientStream pipeClient =
            new NamedPipeClientStream(".", "testpipe", PipeDirection.In))
        {

            // Connect to the pipe or wait until the pipe is available.
            Console.Write("Attempting to connect to pipe...");
            pipeClient.Connect();

            Console.WriteLine("Connected to pipe.");
            Console.WriteLine("There are currently {0} pipe server instances open.",
               pipeClient.NumberOfServerInstances);
            using (StreamReader sr = new StreamReader(pipeClient))
            {
                // Display the read text to the console
                string temp;
                while ((temp = sr.ReadLine()) != null)
                {
                    Console.WriteLine("Received from server: {0}", temp);
                }
            }
        }
        Console.Write("Press Enter to continue...");
        Console.ReadLine();
    }
}
Imports System.IO
Imports System.IO.Pipes
Imports System.Security.Principal

Class PipeClient

    Shared Sub Main(ByVal args As String())

        Dim pipeClient As New NamedPipeClientStream("localhost", _
                    "testpipe", PipeDirection.In, PipeOptions.None)

        ' Connect to the pipe or wait until the pipe is available.
        Console.WriteLine("Attempting to connect to the pipe...")
        pipeClient.Connect()

        Console.WriteLine("Connect to the pipe.")
        Console.WriteLine("There are currently {0} pipe server instances open.", _
                          pipeClient.NumberOfServerInstances)

        Dim sr As New StreamReader(pipeClient)
        Dim temp As String

        temp = sr.ReadLine()
        While Not temp Is Nothing
            Console.WriteLine("Received from server: {0}", temp)
            temp = sr.ReadLine()
        End While
        Console.Write("Press Enter to continue...")
        Console.ReadLine()
    End Sub
End Class

注解

命名管道提供单向或双工管道,用于管道服务器与一个或多个管道客户端之间的通信。 命名管道可用于本地或通过网络进行进程间通信。 单个管道名称可由多个 NamedPipeClientStream 对象共享。

任何进程都可以充当命名管道服务器或客户端,也可以同时充当这两者。

构造函数

NamedPipeClientStream(PipeDirection, Boolean, Boolean, SafePipeHandle)

使用指定的管道方向为指定的管道图柄初始化 NamedPipeClientStream 类的新实例。

NamedPipeClientStream(String)

用指定的管道名称初始化 NamedPipeClientStream 类的新实例。

NamedPipeClientStream(String, String)

使用指定的管道和服务器名称初始化 NamedPipeClientStream 类的新实例。

NamedPipeClientStream(String, String, PipeAccessRights, PipeOptions, TokenImpersonationLevel, HandleInheritability)

使用指定的管道和服务器名称、指定的管道选项、安全模拟级别以及继承模式初始化 NamedPipeClientStream 类的新实例。

NamedPipeClientStream(String, String, PipeDirection)

使用指定的管道和服务器名称,以及指定的管道方向初始化 NamedPipeClientStream 类的新实例。

NamedPipeClientStream(String, String, PipeDirection, PipeOptions)

使用指定的管道和服务器名称,以及指定的管道方向和管道选项初始化 NamedPipeClientStream 类的新实例。

NamedPipeClientStream(String, String, PipeDirection, PipeOptions, TokenImpersonationLevel)

使用指定的管道和服务器名称、指定的管道方向和管道选项以及安全模拟级别初始化 NamedPipeClientStream 类的新实例。

NamedPipeClientStream(String, String, PipeDirection, PipeOptions, TokenImpersonationLevel, HandleInheritability)

使用指定的管道和服务器名称、指定的管道方向、管道选项、安全模拟级别以及继承模式初始化 NamedPipeClientStream 类的新实例。

属性

CanRead

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

(继承自 PipeStream)
CanSeek

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

(继承自 PipeStream)
CanTimeout

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

(继承自 Stream)
CanWrite

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

(继承自 PipeStream)
InBufferSize

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

(继承自 PipeStream)
IsAsync

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

(继承自 PipeStream)
IsConnected

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

(继承自 PipeStream)
IsHandleExposed

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

(继承自 PipeStream)
IsMessageComplete

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

(继承自 PipeStream)
Length

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

(继承自 PipeStream)
NumberOfServerInstances

获取共享同一管道名称的服务器实例的数量。

OutBufferSize

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

(继承自 PipeStream)
Position

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

(继承自 PipeStream)
ReadMode

获取或设置 PipeStream 对象的读取模式。

(继承自 PipeStream)
ReadTimeout

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

(继承自 Stream)
SafePipeHandle

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

(继承自 PipeStream)
TransmissionMode

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

(继承自 PipeStream)
WriteTimeout

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

(继承自 Stream)

方法

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

开始异步读操作。

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

开始异步写操作。

(继承自 PipeStream)
CheckPipePropertyOperations()

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

(继承自 PipeStream)
CheckReadOperations()

验证管道是否处于可供进行读操作的连接状态。

(继承自 PipeStream)
CheckWriteOperations()

验证管道是否处于可供进行写操作的连接状态。

(继承自 PipeStream)
Close()

关闭当前流并释放与之关联的所有资源(如套接字和文件句柄)。 不直接调用此方法,而应确保流得以正确释放。

(继承自 Stream)
Connect()

连接到具有无限超时值的等待的服务器。

Connect(Int32)

在指定的超时期间内连接到等待的服务器。

Connect(TimeSpan)

在指定的超时期限内连接到正在等待的服务器。

ConnectAsync()

在无限超时期间内异步连接到等待的服务器。

ConnectAsync(CancellationToken)

异步连接到等待的服务器并监视取消请求。

ConnectAsync(Int32)

在指定的超时期间内异步连接到等待的服务器。

ConnectAsync(Int32, CancellationToken)

在指定的超时期间内异步连接到等待的服务器并监视取消请求。

ConnectAsync(TimeSpan, CancellationToken)

在指定的超时期间内异步连接到等待的服务器并监视取消请求。

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()

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

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)

扩展方法

GetAccessControl(PipeStream)

返回管道流的安全信息。

SetAccessControl(PipeStream, PipeSecurity)

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

ConfigureAwait(IAsyncDisposable, Boolean)

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

适用于