AnonymousPipeServerStream Класс

Ссылка

Определение

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

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

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

Сборка:: netstandard.dll

Исходный код:: AnonymousPipeServerStream.cs

Исходный код:: AnonymousPipeServerStream.cs

Исходный код:: AnonymousPipeServerStream.cs

Важно!

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

Предоставляет поток для анонимного канала, поддерживающий синхронные и асинхронные операции чтения и записи.

public ref class AnonymousPipeServerStream sealed : System::IO::Pipes::PipeStream

public sealed class AnonymousPipeServerStream : System.IO.Pipes.PipeStream

type AnonymousPipeServerStream = class
    inherit PipeStream

Public NotInheritable Class AnonymousPipeServerStream
Inherits PipeStream

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

Stream

PipeStream
AnonymousPipeServerStream

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

MarshalByRefObject

Stream

PipeStream
AnonymousPipeServerStream

Примеры

В следующем примере строка из родительского процесса отправляется дочернему процессу с помощью анонимных каналов. В этом примере создается AnonymousPipeServerStream объект в родительском процессе со значением PipeDirection PipeDirection.Out. Он также создает AnonymousPipeClientStream объект в дочернем процессе со значением PipeDirection PipeDirection.In. Теперь родительский процесс отправляет предоставленную пользователем строку в дочерний процесс. Строка отображается в консоли.

Этот пример предназначен для серверного процесса, который использует AnonymousPipeServerStream класс . Полный пример кода, включая код для клиента канала и сервера, см. в разделе Практическое руководство. Использование анонимных каналов для локального межпроцессного взаимодействия.

//<snippet01>
#using <System.dll>
#using <System.Core.dll>

using namespace System;
using namespace System::IO;
using namespace System::IO::Pipes;
using namespace System::Diagnostics;

ref class PipeServer
{
public:
    static void Main()
    {
        Process^ pipeClient = gcnew Process();

        pipeClient->StartInfo->FileName = "pipeClient.exe";

        AnonymousPipeServerStream^ pipeServer =
            gcnew AnonymousPipeServerStream(PipeDirection::Out,
            HandleInheritability::Inheritable);

        Console::WriteLine("[SERVER] Current TransmissionMode: {0}.",
            pipeServer->TransmissionMode);

        // Pass the client process a handle to the server.
        pipeClient->StartInfo->Arguments =
            pipeServer->GetClientHandleAsString();
        pipeClient->StartInfo->UseShellExecute = false;
        pipeClient->Start();

        pipeServer->DisposeLocalCopyOfClientHandle();

        try
        {
            // Read user input and send that to the client process.
            StreamWriter^ sw = gcnew StreamWriter(pipeServer);

            sw->AutoFlush = true;
            // Send a 'sync message' and wait for client to receive it.
            sw->WriteLine("SYNC");
            pipeServer->WaitForPipeDrain();
            // Send the console input to the client process.
            Console::Write("[SERVER] Enter text: ");
            sw->WriteLine(Console::ReadLine());
            sw->Close();
        }
        // Catch the IOException that is raised if the pipe is broken
        // or disconnected.
        catch (IOException^ e)
        {
            Console::WriteLine("[SERVER] Error: {0}", e->Message);
        }
        pipeServer->Close();
        pipeClient->WaitForExit();
        pipeClient->Close();
        Console::WriteLine("[SERVER] Client quit. Server terminating.");
    }
};

int main()
{
    PipeServer::Main();
}
//</snippet01>

//<snippet01>
using System;
using System.IO;
using System.IO.Pipes;
using System.Diagnostics;

class PipeServer
{
    static void Main()
    {
        Process pipeClient = new Process();

        pipeClient.StartInfo.FileName = "pipeClient.exe";

        using (AnonymousPipeServerStream pipeServer =
            new AnonymousPipeServerStream(PipeDirection.Out,
            HandleInheritability.Inheritable))
        {
            Console.WriteLine("[SERVER] Current TransmissionMode: {0}.",
                pipeServer.TransmissionMode);

            // Pass the client process a handle to the server.
            pipeClient.StartInfo.Arguments =
                pipeServer.GetClientHandleAsString();
            pipeClient.StartInfo.UseShellExecute = false;
            pipeClient.Start();

            pipeServer.DisposeLocalCopyOfClientHandle();

            try
            {
                // Read user input and send that to the client process.
                using (StreamWriter sw = new StreamWriter(pipeServer))
                {
                    sw.AutoFlush = true;
                    // Send a 'sync message' and wait for client to receive it.
                    sw.WriteLine("SYNC");
                    pipeServer.WaitForPipeDrain();
                    // Send the console input to the client process.
                    Console.Write("[SERVER] Enter text: ");
                    sw.WriteLine(Console.ReadLine());
                }
            }
            // Catch the IOException that is raised if the pipe is broken
            // or disconnected.
            catch (IOException e)
            {
                Console.WriteLine("[SERVER] Error: {0}", e.Message);
            }
        }

        pipeClient.WaitForExit();
        pipeClient.Close();
        Console.WriteLine("[SERVER] Client quit. Server terminating.");
    }
}
//</snippet01>

'<snippet01>
Imports System.IO
Imports System.IO.Pipes
Imports System.Diagnostics

Class PipeServer
    Shared Sub Main()
        Dim pipeClient As New Process()

        pipeClient.StartInfo.FileName = "pipeClient.exe"

        Using pipeServer As New AnonymousPipeServerStream(PipeDirection.Out, _
            HandleInheritability.Inheritable)

            Console.WriteLine("[SERVER] Current TransmissionMode: {0}.",
                pipeServer.TransmissionMode)

            ' Pass the client process a handle to the server.
            pipeClient.StartInfo.Arguments = pipeServer.GetClientHandleAsString()
            pipeClient.StartInfo.UseShellExecute = false
            pipeClient.Start()

            pipeServer.DisposeLocalCopyOfClientHandle()

            Try
                ' Read user input and send that to the client process.
                Using sw As New StreamWriter(pipeServer)
                    sw.AutoFlush = true
                    ' Send a 'sync message' and wait for client to receive it.
                    sw.WriteLine("SYNC")
                    pipeServer.WaitForPipeDrain()
                    ' Send the console input to the client process.
                    Console.Write("[SERVER] Enter text: ")
                    sw.WriteLine(Console.ReadLine())
                End Using
            Catch e As IOException
                ' Catch the IOException that is raised if the pipe is broken
                ' or disconnected.
                Console.WriteLine("[SERVER] Error: {0}", e.Message)
            End Try
        End Using

        pipeClient.WaitForExit()
        pipeClient.Close()
        Console.WriteLine("[SERVER] Client quit. Server terminating.")
    End Sub
End Class
'</snippet01>

Анонимные каналы помогают обеспечить безопасный и безопасный обмен данными между дочерними и родительскими процессами. Класс AnonymousPipeServerStream позволяет родительскому процессу отправлять или получать сведения из дочернего процесса.

Анонимные каналы — это неименованные односторонние каналы, которые обычно передают данные между родительскими и дочерними процессами. Анонимные каналы всегда являются локальными; их нельзя использовать по сети. Значение PipeDirection InOut не поддерживается, так как анонимные каналы определены как односторонние.

Анонимные каналы не поддерживают PipeTransmissionMode.Message режим чтения.

Клиентская часть анонимного канала должна быть создана из дескриптора канала, предоставленного сервером путем вызова GetClientHandleAsString метода . Затем строка передается в качестве параметра при создании клиентского процесса. Из клиентского процесса он затем передается конструктору в AnonymousPipeClientStreampipeHandleAsString качестве параметра .

Объект AnonymousPipeServerStream должен удалить дескриптор клиента с помощью DisposeLocalCopyOfClientHandle метода , чтобы получать уведомления о выходе клиента.

Конструкторы

AnonymousPipeServerStream()	Инициализирует новый экземпляр класса AnonymousPipeServerStream.
AnonymousPipeServerStream(PipeDirection)	Инициализирует новый экземпляр класса AnonymousPipeServerStream с указанным направлением канала.
AnonymousPipeServerStream(PipeDirection, HandleInheritability)	Инициализирует новый экземпляр класса AnonymousPipeServerStream с указанным направлением канала и режимом наследования.
AnonymousPipeServerStream(PipeDirection, HandleInheritability, Int32)	Инициализирует новый экземпляр класса AnonymousPipeServerStream с указанным направлением канала, режимом наследования и размером буфера.
AnonymousPipeServerStream(PipeDirection, HandleInheritability, Int32, PipeSecurity)	Инициализирует новый экземпляр класса AnonymousPipeServerStream с указанным направлением канала, режимом наследования, размером буфера и режимом безопасности канала.
AnonymousPipeServerStream(PipeDirection, SafePipeHandle, SafePipeHandle)	Инициализирует новый экземпляр класса AnonymousPipeServerStream на основе указанного дескриптора канала.

Свойства

CanRead	Возвращает значение, указывающее, поддерживает ли текущий поток операции чтения. (Унаследовано от PipeStream)
CanSeek	Возвращает значение, указывающее, поддерживает ли текущий поток операции поиска. (Унаследовано от PipeStream)
CanTimeout	Возвращает значение, которое показывает, может ли для данного потока истечь время ожидания. (Унаследовано от Stream)
CanWrite	Возвращает значение, указывающее, поддерживает ли текущий поток операции записи. (Унаследовано от PipeStream)
ClientSafePipeHandle	Получает безопасный дескриптор для объекта AnonymousPipeClientStream, который в данный момент подключен к объекту AnonymousPipeServerStream.
InBufferSize	Получает размер (в байтах) входящего буфера для канала. (Унаследовано от PipeStream)
IsAsync	Возвращает значение, показывающее, как был открыт объект PipeStream — синхронно или асинхронно. (Унаследовано от PipeStream)
IsConnected	Возвращает или задает значение, указывающее, подключен ли объект PipeStream. (Унаследовано от PipeStream)
IsHandleExposed	Возвращает значение, указывающее, предоставлен ли дескриптор в объект PipeStream. (Унаследовано от PipeStream)
IsMessageComplete	Возвращает значение, указывающее, содержатся ли еще данные в сообщении, возвращенном из последней операции чтения. (Унаследовано от PipeStream)
Length	Получает длину потока в байтах. (Унаследовано от PipeStream)
OutBufferSize	Получает размер (в байтах) исходящего буфера для канала. (Унаследовано от PipeStream)
Position	Возвращает или задает текущую позицию в текущем потоке. (Унаследовано от PipeStream)
ReadMode	Задает режим чтения для объекта AnonymousPipeServerStream. Для анонимных каналов режим передачи должен иметь значение Byte.
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)
DisposeLocalCopyOfClientHandle()	Закрывает локальную копию дескриптора объекта AnonymousPipeClientStream.
EndRead(IAsyncResult)	Завершает отложенный запрос асинхронного чтения. (Унаследовано от PipeStream)
EndWrite(IAsyncResult)	Завершает отложенный запрос асинхронной записи. (Унаследовано от PipeStream)
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
Finalize()	Освобождает неуправляемые ресурсы и выполняет другие операции очистки, прежде чем память, занимаемая данным экземпляром AnonymousPipeServerStream, будет освобождена в процессе сборки мусора.
Flush()	Очищает буфер для текущего потока и вызывает запись всех буферизованных данных в соответствующее устройство. (Унаследовано от PipeStream)
FlushAsync()	Асинхронно очищает все буферы для этого потока и вызывает запись всех буферизованных данных в базовое устройство. (Унаследовано от Stream)
FlushAsync(CancellationToken)	Асинхронно очищает буфер для текущего потока и вызывает запись всех буферизованных данных в соответствующее устройство. (Унаследовано от PipeStream)
GetAccessControl()	Возвращает объект PipeSecurity, который инкапсулирует записи списка управления доступом (ACL) для канала, описываемого текущим объектом PipeStream. (Унаследовано от PipeStream)
GetClientHandleAsString()	Возвращает дескриптор подключенного объекта AnonymousPipeClientStream в виде строки.
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)

Методы расширения

CopyToAsync(Stream, PipeWriter, CancellationToken)	Асинхронно считывает байты из Stream и записывает их в указанный PipeWriter, используя токен отмены.
GetAccessControl(PipeStream)	Возвращает сведения о безопасности для потока канала.
SetAccessControl(PipeStream, PipeSecurity)	Изменяет атрибуты безопасности для существующего потока канала.
ConfigureAwait(IAsyncDisposable, Boolean)	Настраивает способ выполнения ожиданий для задач, возвращаемых из асинхронного высвобождаемого объекта.

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