PipeStream Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Предоставляет объект Stream вокруг канала, который поддерживает как анонимные, так и именованные каналы.
public ref class PipeStream abstract : System::IO::Streampublic abstract class PipeStream : System.IO.Streamtype PipeStream = class
inherit StreamPublic MustInherit Class PipeStream
Inherits Stream- Наследование
- Наследование
- Производный
Комментарии
Класс PipeStream предоставляет базовый класс для операций именованных и анонимных каналов в .NET Framework. Используйте классы NamedPipeServerStream и NamedPipeClientStream для именованных операций канала. Используйте классы AnonymousPipeServerStream и AnonymousPipeClientStream для анонимных операций канала.
Дополнительные сведения о каналах см. в разделе Трубы. Пример анонимных каналов см. в разделе Практическое руководство. Использование анонимных каналов для локальной межпроцессной связи. Пример именованных каналов см. в разделе How to: Use Named Pipes for Network Interprocess Communication.
Конструкторы
| 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) |
Считывает |
| ReadExactly(Span<Byte>) |
Считывает байты из текущего потока и перемещает позицию в потоке до заполнения |
| ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken) |
Асинхронно считывает |
| ReadExactlyAsync(Memory<Byte>, CancellationToken) |
Асинхронно считывает байты из текущего потока, перемещает положение в потоке до заполнения |
| 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) |
Записывает байт в текущий поток. |
Методы расширения
| CopyToAsync(Stream, PipeWriter, CancellationToken) |
Асинхронно считывает байты из Stream и записывает их в указанный PipeWriterс помощью маркера отмены. |
| GetAccessControl(PipeStream) |
Возвращает сведения о безопасности потока канала. |
| SetAccessControl(PipeStream, PipeSecurity) |
Изменяет атрибуты безопасности существующего потока канала. |
| ConfigureAwait(IAsyncDisposable, Boolean) |
Настраивает способ ожидания задач, возвращаемых из асинхронного удаления. |
