NamedPipeServerStream 构造函数

定义

命名空间:

System.IO.Pipes

程序集:

System.IO.Pipes.dll

初始化 NamedPipeServerStream 类的新实例。

重载

NamedPipeServerStream(String)	用指定的管道名称初始化 NamedPipeServerStream 类的新实例。
NamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode, PipeOptions, Int32, Int32)	使用指定的管道名称、管道方向、最大数量的服务器实例、传输模式、管道选项和建议的输入输出缓冲区大小初始化 NamedPipeServerStream 类的新实例。
NamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode, PipeOptions)	使用指定的管道名称、管道方向、最大数量的服务器实例、传输模式和管道选项初始化 NamedPipeServerStream 类的新实例。
NamedPipeServerStream(PipeDirection, Boolean, Boolean, SafePipeHandle)	从指定的管道句柄初始化 NamedPipeServerStream 类的一个新实例。
NamedPipeServerStream(String, PipeDirection, Int32)	使用指定的管道名称、管道方向和最大数量的服务器实例初始化 NamedPipeServerStream 类的一个新实例。
NamedPipeServerStream(String, PipeDirection)	使用指定的管道名称和管道方向初始化 NamedPipeServerStream 类的新实例。
NamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode)	使用指定的管道名称、管道方向、最大数量的服务器实例和传输模式初始化 NamedPipeServerStream 类的新实例。

NamedPipeServerStream(String)

Source:

NamedPipeServerStream.cs

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

public:
 NamedPipeServerStream(System::String ^ pipeName);

public NamedPipeServerStream (string pipeName);

new System.IO.Pipes.NamedPipeServerStream : string -> System.IO.Pipes.NamedPipeServerStream

Public Sub New (pipeName As String)

参数

pipeName

String

管道的名称。

例外

ArgumentNullException

pipeName 为 null。

ArgumentException

pipeName 是一个长度为零的字符串。

ArgumentOutOfRangeException

pipeName 设置为“匿名”。

NotSupportedException

pipeName 包含一个冒号 (":")。

IOException

已超出服务器实例的最大数量。

注解

此构造函数创建具有以下 NamedPipeServerStream 特征的对象：

• 默认管道方向 InOut。

• 共享同名的最大服务器实例数设置为 1。

• 一个 PipeTransmissionMode 的 Byte 值。

• 一个 PipeOptions 的 None 值。

• 默认输入和输出缓冲区大小。

• 无管道安全性。

• 一个 HandleInheritability 的 None 值。

• 未指定其他 PipeAccessRights。

NamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode, PipeOptions, Int32, Int32)

Source:

NamedPipeServerStream.cs

使用指定的管道名称、管道方向、最大数量的服务器实例、传输模式、管道选项和建议的输入输出缓冲区大小初始化 NamedPipeServerStream 类的新实例。

public:
 NamedPipeServerStream(System::String ^ pipeName, System::IO::Pipes::PipeDirection direction, int maxNumberOfServerInstances, System::IO::Pipes::PipeTransmissionMode transmissionMode, System::IO::Pipes::PipeOptions options, int inBufferSize, int outBufferSize);

public NamedPipeServerStream (string pipeName, System.IO.Pipes.PipeDirection direction, int maxNumberOfServerInstances, System.IO.Pipes.PipeTransmissionMode transmissionMode, System.IO.Pipes.PipeOptions options, int inBufferSize, int outBufferSize);

new System.IO.Pipes.NamedPipeServerStream : string * System.IO.Pipes.PipeDirection * int * System.IO.Pipes.PipeTransmissionMode * System.IO.Pipes.PipeOptions * int * int -> System.IO.Pipes.NamedPipeServerStream

Public Sub New (pipeName As String, direction As PipeDirection, maxNumberOfServerInstances As Integer, transmissionMode As PipeTransmissionMode, options As PipeOptions, inBufferSize As Integer, outBufferSize As Integer)

参数

pipeName

String

管道的名称。

direction

PipeDirection

确定管道方向的枚举值之一。

maxNumberOfServerInstances

Int32

共享同一名称的服务器实例的最大数量。 可以为此值传递 MaxAllowedServerInstances。

transmissionMode

PipeTransmissionMode

确定管道传输模式的枚举值之一。

options

PipeOptions

确定如何打开或创建管道的枚举值之一。

inBufferSize

Int32

一个大于 0 的正值，指示输入缓冲区大小。

outBufferSize

Int32

一个大于 0 的正值，指示输出缓冲区大小。

例外

ArgumentNullException

pipeName 为 null。

ArgumentException

pipeName 是一个长度为零的字符串。

ArgumentOutOfRangeException

pipeName 设置为“匿名”。

- 或 -

direction 不是有效的 PipeDirection 值。

- 或 -

maxNumberofServerInstances 小于 -1 或大于 254（-1 指示 MaxAllowedServerInstances）

- 或 -

options 不是有效的 PipeOptions 值。

- 或 -

inBufferSize 为负数。

NotSupportedException

pipeName 包含一个冒号 (":")。

IOException

已超出服务器实例的最大数量。

注解

此构造函数创建具有以下 NamedPipeServerStream 特征的对象：

• 没有额外的管道安全性。

• 默认值 HandleInheritabilityNone。

• 未指定其他 PipeAccessRights。

NamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode, PipeOptions)

Source:

NamedPipeServerStream.cs

使用指定的管道名称、管道方向、最大数量的服务器实例、传输模式和管道选项初始化 NamedPipeServerStream 类的新实例。

public:
 NamedPipeServerStream(System::String ^ pipeName, System::IO::Pipes::PipeDirection direction, int maxNumberOfServerInstances, System::IO::Pipes::PipeTransmissionMode transmissionMode, System::IO::Pipes::PipeOptions options);

public NamedPipeServerStream (string pipeName, System.IO.Pipes.PipeDirection direction, int maxNumberOfServerInstances, System.IO.Pipes.PipeTransmissionMode transmissionMode, System.IO.Pipes.PipeOptions options);

new System.IO.Pipes.NamedPipeServerStream : string * System.IO.Pipes.PipeDirection * int * System.IO.Pipes.PipeTransmissionMode * System.IO.Pipes.PipeOptions -> System.IO.Pipes.NamedPipeServerStream

Public Sub New (pipeName As String, direction As PipeDirection, maxNumberOfServerInstances As Integer, transmissionMode As PipeTransmissionMode, options As PipeOptions)

参数

pipeName

String

管道的名称。

direction

PipeDirection

确定管道方向的枚举值之一。

maxNumberOfServerInstances

Int32

共享同一名称的服务器实例的最大数量。 可以为此值传递 MaxAllowedServerInstances。

transmissionMode

PipeTransmissionMode

确定管道传输模式的枚举值之一。

options

PipeOptions

确定如何打开或创建管道的枚举值之一。

例外

ArgumentNullException

pipeName 为 null。

ArgumentException

pipeName 是一个长度为零的字符串。

ArgumentOutOfRangeException

pipeName 设置为“匿名”。

- 或 -

direction 不是有效的 PipeDirection 值。

- 或 -

maxNumberofServerInstances 小于 -1 或大于 254（-1 指示 MaxAllowedServerInstances）

- 或 -

options 不是有效的 PipeOptions 值。

NotSupportedException

pipeName 包含一个冒号 (":")。

IOException

已超出服务器实例的最大数量。

注解

此构造函数创建具有以下 NamedPipeServerStream 特征的对象：

• 默认输入和输出缓冲区大小。

• 无管道安全性。

• 一个 HandleInheritability 的 None 值。

• 未指定其他 PipeAccessRights。

NamedPipeServerStream(PipeDirection, Boolean, Boolean, SafePipeHandle)

Source:

NamedPipeServerStream.Unix.cs

从指定的管道句柄初始化 NamedPipeServerStream 类的一个新实例。

public:
 NamedPipeServerStream(System::IO::Pipes::PipeDirection direction, bool isAsync, bool isConnected, Microsoft::Win32::SafeHandles::SafePipeHandle ^ safePipeHandle);

public NamedPipeServerStream (System.IO.Pipes.PipeDirection direction, bool isAsync, bool isConnected, Microsoft.Win32.SafeHandles.SafePipeHandle safePipeHandle);

new System.IO.Pipes.NamedPipeServerStream : System.IO.Pipes.PipeDirection * bool * bool * Microsoft.Win32.SafeHandles.SafePipeHandle -> System.IO.Pipes.NamedPipeServerStream

Public Sub New (direction As PipeDirection, isAsync As Boolean, isConnected As Boolean, safePipeHandle As SafePipeHandle)

参数

direction

PipeDirection

确定管道方向的枚举值之一。

isAsync

Boolean

true 指示句柄已异步打开；否则为 false。

isConnected

Boolean

指示管道已连接，则为 true；否则为 false。

safePipeHandle

SafePipeHandle

此 NamedPipeServerStream 对象将封装的管道的安全句柄。

例外

ArgumentOutOfRangeException

direction 不是有效的 PipeDirection 值。

ArgumentNullException

safePipeHandle 为 null。

ArgumentException

safePipeHandle 是无效的句柄。

IOException

safePipeHandle 不是有效的管道句柄。

- 或 -

已超出服务器实例的最大数量。

NamedPipeServerStream(String, PipeDirection, Int32)

Source:

NamedPipeServerStream.cs

使用指定的管道名称、管道方向和最大数量的服务器实例初始化 NamedPipeServerStream 类的一个新实例。

public:
 NamedPipeServerStream(System::String ^ pipeName, System::IO::Pipes::PipeDirection direction, int maxNumberOfServerInstances);

public NamedPipeServerStream (string pipeName, System.IO.Pipes.PipeDirection direction, int maxNumberOfServerInstances);

new System.IO.Pipes.NamedPipeServerStream : string * System.IO.Pipes.PipeDirection * int -> System.IO.Pipes.NamedPipeServerStream

Public Sub New (pipeName As String, direction As PipeDirection, maxNumberOfServerInstances As Integer)

参数

pipeName

String

管道的名称。

direction

PipeDirection

确定管道方向的枚举值之一。

maxNumberOfServerInstances

Int32

共享同一名称的服务器实例的最大数量。 可以为此值传递 MaxAllowedServerInstances。

例外

ArgumentNullException

pipeName 为 null。

ArgumentException

pipeName 是一个长度为零的字符串。

ArgumentOutOfRangeException

pipeName 设置为“匿名”。

- 或 -

direction 不是有效的 PipeDirection 值。

- 或 -

需要非负数。

- 或 -

maxNumberofServerInstances 小于 -1 或大于 254（-1 指示 MaxAllowedServerInstances）

- 或 -

需要 None 或 Inheritable。

- 或 -

访问权限仅限于 ChangePermissions、TakeOwnership 和 AccessSystemSecurity 标志。

NotSupportedException

pipeName 包含一个冒号 (":")。

IOException

已超出服务器实例的最大数量。

注解

此构造函数创建具有以下 NamedPipeServerStream 特征的对象：

• 对于共享同名的最大服务器实例数，默认值为 1。

• 默认值 PipeTransmissionModeByte。

• 一个 PipeOptions 的 None 值。

• 默认输入和输出缓冲区大小。

• 无管道安全性。

• 一个 HandleInheritability 的 None 值。

• 未指定其他 PipeAccessRights。

NamedPipeServerStream(String, PipeDirection)

Source:

NamedPipeServerStream.cs

使用指定的管道名称和管道方向初始化 NamedPipeServerStream 类的新实例。

public:
 NamedPipeServerStream(System::String ^ pipeName, System::IO::Pipes::PipeDirection direction);

public NamedPipeServerStream (string pipeName, System.IO.Pipes.PipeDirection direction);

new System.IO.Pipes.NamedPipeServerStream : string * System.IO.Pipes.PipeDirection -> System.IO.Pipes.NamedPipeServerStream

Public Sub New (pipeName As String, direction As PipeDirection)

参数

pipeName

String

管道的名称。

direction

PipeDirection

确定管道方向的枚举值之一。

例外

ArgumentNullException

pipeName 为 null。

ArgumentException

pipeName 是一个长度为零的字符串。

ArgumentOutOfRangeException

pipeName 设置为“匿名”。

- 或 -

direction 不是有效的 PipeDirection 值。

NotSupportedException

pipeName 包含一个冒号 (":")。

IOException

已超出服务器实例的最大数量。

示例

以下示例演示了使用命名管道将字符串从父进程发送到子进程的方法。 此示例在 NamedPipeServerStream 父进程中创建对象。 对象的NamedPipeServerStreamPipeDirection值为 Out，然后会阻止该对象，直到NamedPipeClientStream对象与当前NamedPipeServerStream对象建立连接。

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

class PipeServer
{
    static void Main()
    {
        using (NamedPipeServerStream pipeServer =
            new NamedPipeServerStream("testpipe", PipeDirection.Out))
        {
            Console.WriteLine("NamedPipeServerStream object created.");

            // Wait for a client to connect
            Console.Write("Waiting for client connection...");
            pipeServer.WaitForConnection();

            Console.WriteLine("Client connected.");
            try
            {
                // Read user input and send that to the client process.
                using (StreamWriter sw = new StreamWriter(pipeServer))
                {
                    sw.AutoFlush = true;
                    Console.Write("Enter text: ");
                    sw.WriteLine(Console.ReadLine());
                }
            }
            // Catch the IOException that is raised if the pipe is broken
            // or disconnected.
            catch (IOException e)
            {
                Console.WriteLine("ERROR: {0}", e.Message);
            }
        }
    }
}

Imports System.IO
Imports System.IO.Pipes

Class PipeServer

    Shared Sub Main()
        Dim pipeServer As New NamedPipeServerStream("testpipe", PipeDirection.Out)

        Console.WriteLine("NamedPipeServerStream object created.")

        ' Wait for a client to connect
        Console.Write("Waiting for a client connection...")
        pipeServer.WaitForConnection()

        Console.WriteLine("Client connected.")
        Try
            'Read user input and send that to the client process.
            Dim sw As New StreamWriter(pipeServer)
            sw.AutoFlush = True
            Console.Write("Enter Text: ")
            sw.WriteLine(Console.ReadLine())
        Catch ex As IOException
            ' Catch the IOException that is raised if the pipe is broken
            ' or disconnected
            Console.WriteLine("ERROR: {0}", ex.Message)
        End Try
    End Sub
End Class

注解

此构造函数创建具有以下 NamedPipeServerStream 特征的对象：

• 一个 PipeTransmissionMode 的 Byte 值。

• 一个 PipeOptions 的 None 值。

• 默认输入和输出缓冲区大小。

• 无管道安全性。

• 一个 HandleInheritability 的 None 值。

• 未指定其他 PipeAccessRights。

NamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode)

Source:

NamedPipeServerStream.cs

使用指定的管道名称、管道方向、最大数量的服务器实例和传输模式初始化 NamedPipeServerStream 类的新实例。

public:
 NamedPipeServerStream(System::String ^ pipeName, System::IO::Pipes::PipeDirection direction, int maxNumberOfServerInstances, System::IO::Pipes::PipeTransmissionMode transmissionMode);

public NamedPipeServerStream (string pipeName, System.IO.Pipes.PipeDirection direction, int maxNumberOfServerInstances, System.IO.Pipes.PipeTransmissionMode transmissionMode);

new System.IO.Pipes.NamedPipeServerStream : string * System.IO.Pipes.PipeDirection * int * System.IO.Pipes.PipeTransmissionMode -> System.IO.Pipes.NamedPipeServerStream

Public Sub New (pipeName As String, direction As PipeDirection, maxNumberOfServerInstances As Integer, transmissionMode As PipeTransmissionMode)

参数

pipeName

String

管道的名称。

direction

PipeDirection

确定管道方向的枚举值之一。

maxNumberOfServerInstances

Int32

共享同一名称的服务器实例的最大数量。 可以为此值传递 MaxAllowedServerInstances。

transmissionMode

PipeTransmissionMode

确定管道传输模式的枚举值之一。

例外

ArgumentNullException

pipeName 为 null。

ArgumentException

pipeName 是一个长度为零的字符串。

ArgumentOutOfRangeException

pipeName 设置为“匿名”。

- 或 -

direction 不是有效的 PipeDirection 值。

- 或 -

maxNumberofServerInstances 小于 -1 或大于 254（-1 指示 MaxAllowedServerInstances）

NotSupportedException

pipeName 包含一个冒号 (":")。

IOException

已超出服务器实例的最大数量。

注解

此构造函数创建具有以下 NamedPipeServerStream 特征的对象：

• 默认值 PipeOptionsNone。

• 默认输入和输出缓冲区大小。

• 无管道安全性。

• 一个 HandleInheritability 的 None 值。

• 未指定其他 PipeAccessRights。