NamedPipeClientStream Класс

Ссылка

Определение

Пространство имен:: System.IO.Pipes

Сборка:: System.IO.Pipes.dll

Сборка:: System.Core.dll

Сборка:: netstandard.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Предоставляет объект 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

Наследование: Object

Stream

PipeStream
NamedPipeClientStream

Наследование: Object

MarshalByRefObject

Stream

PipeStream
NamedPipeClientStream

Примеры

В следующем примере показан способ отправки строки из родительского процесса в дочерний процесс на том же компьютере с помощью именованных каналов. В этом примере создается NamedPipeServerStream объект в родительском процессе. Объект NamedPipeServerStream имеет PipeDirection значение Out. Затем сервер ожидает, пока NamedPipeClientStream объект в дочернем процессе будет подключен к нему. В этом примере оба процесса находятся на одном компьютере, а NamedPipeClientStream объект имеет PipeDirection значение 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, который инкапсулирует записи списка управления доступом (ACL) для канала, описываемого текущим объектом PipeStream. (Унаследовано от 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)	Применяет записи списка управления доступом (ACL), заданные объектом PipeSecurity, к каналу, заданному текущим объектом 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)	Настраивает способ выполнения ожиданий для задач, возвращаемых из асинхронного высвобождаемого объекта.

Применяется к