PipeStream Класс

Ссылка

Определение

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

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

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

Сборка:: netstandard.dll

Важно!

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

Предоставляет объект Stream для канала, поддерживающий анонимные и именованные каналы.

public ref class PipeStream abstract : System::IO::Stream

public abstract class PipeStream : System.IO.Stream

type PipeStream = class
    inherit Stream

Public MustInherit Class PipeStream
Inherits Stream

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

Stream
PipeStream

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

MarshalByRefObject

Stream
PipeStream

Производный: System.IO.Pipes.AnonymousPipeClientStream

System.IO.Pipes.AnonymousPipeServerStream

System.IO.Pipes.NamedPipeClientStream

System.IO.Pipes.NamedPipeServerStream

Этот PipeStream класс предоставляет базовый класс для операций именованных и анонимных каналов в платформа .NET Framework. NamedPipeServerStream Используйте классы для NamedPipeClientStream операций именованного канала. AnonymousPipeServerStream Используйте классы и AnonymousPipeClientStream классы для анонимных операций конвейера.

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

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

PipeStream(PipeDirection, Int32)	Инициализирует новый экземпляр класса PipeStream с использованием указанного значения PipeDirection и размера буфера.
PipeStream(PipeDirection, PipeTransmissionMode, Int32)	Инициализирует новый экземпляр класса PipeStream с использованием указанных значений PipeDirection, PipeTransmissionMode и размера буфера.

Свойства

CanRead	Возвращает значение, указывающее, поддерживает ли текущий поток операции чтения.
CanSeek	Возвращает значение, указывающее, поддерживает ли текущий поток операции поиска.
CanTimeout	Возвращает значение, которое показывает, может ли для данного потока истечь время ожидания. (Унаследовано от Stream)
CanWrite	Возвращает значение, указывающее, поддерживает ли текущий поток операции записи.
InBufferSize	Получает размер (в байтах) входящего буфера для канала.
IsAsync	Возвращает значение, показывающее, как был открыт объект PipeStream — синхронно или асинхронно.
IsConnected	Возвращает или задает значение, указывающее, подключен ли объект PipeStream.
IsHandleExposed	Возвращает значение, указывающее, предоставлен ли дескриптор в объект PipeStream.
IsMessageComplete	Возвращает значение, указывающее, содержатся ли еще данные в сообщении, возвращенном из последней операции чтения.
Length	Получает длину потока в байтах.
OutBufferSize	Получает размер (в байтах) исходящего буфера для канала.
Position	Возвращает или задает текущую позицию в текущем потоке.
ReadMode	Возвращает или задает режим чтения для объекта PipeStream.
ReadTimeout	Возвращает или задает значение в миллисекундах, определяющее период времени, отведенного потоку на выполнение операции чтения. (Унаследовано от Stream)
SafePipeHandle	Получает безопасный дескриптор для локального конца канала, инкапсулируемого текущим объектом PipeStream.
TransmissionMode	Возвращает режим передачи, поддерживаемый текущим каналом.
WriteTimeout	Возвращает или задает значение в миллисекундах, определяющее период времени, отведенного потоку на выполнение операции записи. (Унаследовано от Stream)

Методы

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Начинает операцию асинхронного чтения.
BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Начинает операцию асинхронного чтения. (Рекомендуется использовать ReadAsync(Byte[], Int32, Int32).) (Унаследовано от Stream)
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Начинает операцию асинхронной записи.
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Начинает операцию асинхронной записи. (Рекомендуется использовать WriteAsync(Byte[], Int32, Int32).) (Унаследовано от Stream)
CheckPipePropertyOperations()	Проверяет, допускает ли состояние канала получение или установку свойств.
CheckReadOperations()	Проверяет, находится ли канал в подключенном состоянии для выполнения операций чтения.
CheckWriteOperations()	Проверяет, находится ли канал в подключенном состоянии для выполнения операций записи.
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 (при необходимости освобождает и управляемые ресурсы).
DisposeAsync()	Асинхронно освобождает неуправляемые ресурсы, используемые классом Stream. (Унаследовано от Stream)
EndRead(IAsyncResult)	Завершает отложенный запрос асинхронного чтения.
EndRead(IAsyncResult)	Ожидает завершения отложенного асинхронного чтения. (Рекомендуется использовать ReadAsync(Byte[], Int32, Int32).) (Унаследовано от Stream)
EndWrite(IAsyncResult)	Завершает отложенный запрос асинхронной записи.
EndWrite(IAsyncResult)	Заканчивает операцию асинхронной записи. (Рекомендуется использовать WriteAsync(Byte[], Int32, Int32).) (Унаследовано от Stream)
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
Flush()	Очищает буфер для текущего потока и вызывает запись всех буферизованных данных в соответствующее устройство.
FlushAsync()	Асинхронно очищает все буферы для этого потока и вызывает запись всех буферизованных данных в базовое устройство. (Унаследовано от Stream)
FlushAsync(CancellationToken)	Асинхронно очищает буфер для текущего потока и вызывает запись всех буферизованных данных в соответствующее устройство.
FlushAsync(CancellationToken)	Асинхронно очищает все буферы данного потока, вызывает запись буферизованных данных в базовое устройство и отслеживает запросы отмены. (Унаследовано от Stream)
GetAccessControl()	Возвращает объект PipeSecurity, который инкапсулирует записи списка управления доступом (ACL) для канала, описываемого текущим объектом PipeStream.
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetLifetimeService()	Является устаревшей. Извлекает объект обслуживания во время существования, который управляет политикой времени существования данного экземпляра. (Унаследовано от MarshalByRefObject)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
InitializeHandle(SafePipeHandle, Boolean, Boolean)	Инициализирует объект PipeStream из указанного объекта SafePipeHandle.
InitializeLifetimeService()	Является устаревшей. Получает объект службы времени существования для управления политикой времени существования для этого экземпляра. (Унаследовано от MarshalByRefObject)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
MemberwiseClone(Boolean)	Создает неполную копию текущего объекта MarshalByRefObject. (Унаследовано от MarshalByRefObject)
ObjectInvariant()	Является устаревшей. Обеспечивает поддержку для Contract. (Унаследовано от Stream)
Read(Byte[], Int32, Int32)	Считывает блок байтов из потока и записывает данные в указанный буфер, начиная с заданной позиции с учетом указанной длины.
Read(Span<Byte>)	Считывает последовательность байтов из текущего потока, записывает их в массив байтов и перемещает позицию внутри потока на число считанных байтов.
Read(Span<Byte>)	При переопределении в производном классе считывает последовательность байтов из текущего потока и перемещает позицию в потоке на число считанных байтов. (Унаследовано от Stream)
ReadAsync(Byte[], Int32, Int32)	Асинхронно считывает последовательность байтов из текущего потока и перемещает позицию внутри потока на число считанных байтов. (Унаследовано от Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Асинхронно считывает последовательность байтов из текущего потока в массив байтов, начиная с указанной позиции, с учетом указанного числа байтов, перемещает позицию в потоке на число считанных байтов и отслеживает запросы отмены.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Асинхронно считывает последовательность байтов из текущего потока, перемещает позицию в потоке на число считанных байтов и отслеживает запросы отмены. (Унаследовано от Stream)
ReadAsync(Memory<Byte>, CancellationToken)	Асинхронно считывает последовательность байтов из текущего потока, записывает их в диапазон памяти байтов, перемещает позицию в потоке на число считанных байтов и отслеживает запросы отмены.
ReadAsync(Memory<Byte>, CancellationToken)	Асинхронно считывает последовательность байтов из текущего потока, перемещает позицию в потоке на число считанных байтов и отслеживает запросы отмены. (Унаследовано от Stream)
ReadAtLeast(Span<Byte>, Int32, Boolean)	Считывает по крайней мере минимальное количество байтов из текущего потока и перемещает позицию в потоке на число прочитанных байтов. (Унаследовано от Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Асинхронно считывает по крайней мере минимальное количество байтов из текущего потока, перемещает позицию в потоке на число прочитанных байтов и отслеживает запросы на отмену. (Унаследовано от Stream)
ReadByte()	Считывает байт из канала.
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)	Устанавливает заданное значение в качестве текущей позиции в текущем потоке.
SetAccessControl(PipeSecurity)	Применяет записи списка управления доступом (ACL), заданные объектом PipeSecurity, к каналу, заданному текущим объектом PipeStream.
SetLength(Int64)	Задает указанное значение для длины текущего потока.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)
WaitForPipeDrain()	Ожидает завершения считывания всех отправленных байтов на противоположном конце канала.
Write(Byte[], Int32, Int32)	Записывает в текущий поток блок байтов, используя данные из буфера.
Write(ReadOnlySpan<Byte>)	Записывает последовательность байтов в текущий поток и перемещает текущую позицию внутри потока на число записанных байтов.
Write(ReadOnlySpan<Byte>)	При переопределении в производном классе записывает последовательность байтов в текущий поток и перемещает текущую позицию в нем вперед на число записанных байтов. (Унаследовано от Stream)
WriteAsync(Byte[], Int32, Int32)	Асинхронно записывает последовательность байтов в текущий поток и перемещает текущую позицию внутри потока на число записанных байтов. (Унаследовано от Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Асинхронно записывает указанное число байтов из текущего потока в массив байтов, начиная с указанной позиции, перемещает позицию в потоке на число считанных байтов и отслеживает запросы отмены.
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Асинхронно записывает последовательность байтов в текущий поток, перемещает текущую позицию внутри потока на число записанных байтов и отслеживает запросы отмены. (Унаследовано от Stream)
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Асинхронно записывает последовательность байтов в текущий поток, перемещает текущую позицию внутри потока на число записанных байтов и отслеживает запросы отмены.
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Асинхронно записывает последовательность байтов в текущий поток, перемещает текущую позицию внутри потока на число записанных байтов и отслеживает запросы отмены. (Унаследовано от Stream)
WriteByte(Byte)	Выполняет запись байта в текущий поток.

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

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

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