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)

Исходный код:

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 задано значение anonymous.

NotSupportedException

pipeName содержит двоеточие (":").

IOException

Превышено максимальное число экземпляров сервера.

Комментарии

Этот конструктор создает NamedPipeServerStream объект со следующими характеристиками:

• Направление канала по умолчанию для InOut.

• Максимальное число экземпляров сервера с одинаковым именем равно 1.

• Значение PipeTransmissionMode для Byte.

• Значение PipeOptions для None.

• Размеры входных и выходных буферов по умолчанию.

• Нет безопасности канала.

• Значение HandleInheritability для None.

• Нет указанных дополнительных .PipeAccessRights

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

Исходный код:

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 задано значение anonymous.

-или-

direction не является допустимым значением PipeDirection.

-или-

Для параметра maxNumberofServerInstances задано значение меньше -1 или больше 254 (значение -1 представляет собой MaxAllowedServerInstances).

-или-

options не является допустимым значением PipeOptions.

-или-

inBufferSize является отрицательным значением.

NotSupportedException

pipeName содержит двоеточие (":").

IOException

Превышено максимальное число экземпляров сервера.

Комментарии

Этот конструктор создает NamedPipeServerStream объект со следующими характеристиками:

• Нет дополнительной безопасности канала.

• Значение Noneпо умолчанию HandleInheritability — .

• Нет указанных дополнительных .PipeAccessRights

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

Исходный код:

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 задано значение anonymous.

-или-

direction не является допустимым значением PipeDirection.

-или-

Для параметра maxNumberofServerInstances задано значение меньше -1 или больше 254 (значение -1 представляет собой MaxAllowedServerInstances).

-или-

options не является допустимым значением PipeOptions.

NotSupportedException

pipeName содержит двоеточие (":").

IOException

Превышено максимальное число экземпляров сервера.

Комментарии

Этот конструктор создает NamedPipeServerStream объект со следующими характеристиками:

• Размеры входных и выходных буферов по умолчанию.

• Нет безопасности канала.

• Значение HandleInheritability для None.

• Нет указанных дополнительных .PipeAccessRights

NamedPipeServerStream(PipeDirection, Boolean, Boolean, SafePipeHandle)

Исходный код:

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)

Исходный код:

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 задано значение anonymous.

-или-

direction не является допустимым значением PipeDirection.

-или-

Требуется неотрицательное число.

-или-

Для параметра maxNumberofServerInstances задано значение меньше -1 или больше 254 (значение -1 представляет собой MaxAllowedServerInstances).

-или-

Требуется параметр None или Inheritable.

-или-

Права доступа ограничены флагами ChangePermissions, TakeOwnership и AccessSystemSecurity.

NotSupportedException

pipeName содержит двоеточие (":").

IOException

Превышено максимальное число экземпляров сервера.

Комментарии

Этот конструктор создает NamedPipeServerStream объект со следующими характеристиками:

• Значение по умолчанию 1 для максимального числа экземпляров сервера с одинаковым именем.

• Значение Byteпо умолчанию PipeTransmissionMode — .

• Значение PipeOptions для None.

• Размеры входных и выходных буферов по умолчанию.

• Нет безопасности канала.

• Значение HandleInheritability для None.

• Нет указанных дополнительных .PipeAccessRights

NamedPipeServerStream(String, PipeDirection)

Исходный код:

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 задано значение anonymous.

-или-

direction не является допустимым значением PipeDirection.

NotSupportedException

pipeName содержит двоеточие (":").

IOException

Превышено максимальное число экземпляров сервера.

Примеры

В следующем примере демонстрируется метод для отправки строки из родительского процесса в дочерний процесс с помощью именованных каналов. В этом примере создается NamedPipeServerStream объект в родительском процессе. Объект NamedPipeServerStream имеет PipeDirection значение 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)

Исходный код:

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 задано значение anonymous.

-или-

direction не является допустимым значением PipeDirection.

-или-

Для параметра maxNumberofServerInstances задано значение меньше -1 или больше 254 (значение -1 представляет собой MaxAllowedServerInstances).

NotSupportedException

pipeName содержит двоеточие (":").

IOException

Превышено максимальное число экземпляров сервера.

Комментарии

Этот конструктор создает NamedPipeServerStream объект со следующими характеристиками:

• Значение Noneпо умолчанию PipeOptions — .

• Размеры входных и выходных буферов по умолчанию.

• Нет безопасности канала.

• Значение HandleInheritability для None.

• Нет указанных дополнительных .PipeAccessRights