PipeStream Класс

Определение

Предоставляет объект Stream для канала, поддерживающий анонимные и именованные каналы.Exposes a Stream object around a pipe, which supports both anonymous and named pipes.

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
Наследование
PipeStream
Наследование
Производный

Комментарии

Класс PipeStream предоставляет базовый класс для операций именованных и анонимных каналов в .NET Framework.The PipeStream class provides the base class for named and anonymous pipes operations in the .NET Framework. Используйте классы NamedPipeServerStream и NamedPipeClientStream для операций именованного канала.Use the NamedPipeServerStream and NamedPipeClientStream classes for named pipe operations. Используйте классы AnonymousPipeServerStream и AnonymousPipeClientStream для операций с анонимным каналом.Use the AnonymousPipeServerStream and AnonymousPipeClientStream classes for anonymous pipe operations.

Дополнительные сведения о каналах см. в разделе каналы.For more information about pipes, see Pipes. Пример анонимных каналов см. в разделе как использовать анонимные каналы для локального взаимодействия между процессами.For an example of anonymous pipes, see How to: Use Anonymous Pipes for Local Interprocess Communication. Пример именованных каналов см. в разделе как использовать именованные каналы для обмена данными между сетевыми процессами.For an example of named pipes, see How to: Use Named Pipes for Network Interprocess Communication.

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

PipeStream(PipeDirection, Int32)

Инициализирует новый экземпляр класса PipeStream с использованием указанного значения PipeDirection и размера буфера.Initializes a new instance of the PipeStream class using the specified PipeDirection value and buffer size.

PipeStream(PipeDirection, PipeTransmissionMode, Int32)

Инициализирует новый экземпляр класса PipeStream с использованием указанных значений PipeDirection, PipeTransmissionMode и размера буфера.Initializes a new instance of the PipeStream class using the specified PipeDirection, PipeTransmissionMode, and buffer size.

Свойства

CanRead

Возвращает значение, указывающее, поддерживает ли текущий поток операции чтения.Gets a value indicating whether the current stream supports read operations.

CanSeek

Возвращает значение, указывающее, поддерживает ли текущий поток операции поиска.Gets a value indicating whether the current stream supports seek operations.

CanTimeout

Получает значение, которое показывает, может ли для данного потока истечь время ожидания.Gets a value that determines whether the current stream can time out.

(Унаследовано от Stream)
CanWrite

Возвращает значение, указывающее, поддерживает ли текущий поток операции записи.Gets a value indicating whether the current stream supports write operations.

InBufferSize

Получает размер (в байтах) входящего буфера для канала.Gets the size, in bytes, of the inbound buffer for a pipe.

IsAsync

Возвращает значение, показывающее, как был открыт объект PipeStream — синхронно или асинхронно.Gets a value indicating whether a PipeStream object was opened asynchronously or synchronously.

IsConnected

Возвращает или задает значение, указывающее, подключен ли объект PipeStream.Gets or sets a value indicating whether a PipeStream object is connected.

IsHandleExposed

Возвращает значение, указывающее, предоставлен ли дескриптор в объект PipeStream.Gets a value indicating whether a handle to a PipeStream object is exposed.

IsMessageComplete

Возвращает значение, указывающее, содержатся ли еще данные в сообщении, возвращенном из последней операции чтения.Gets a value indicating whether there is more data in the message returned from the most recent read operation.

Length

Получает длину потока в байтах.Gets the length of a stream, in bytes.

OutBufferSize

Получает размер (в байтах) исходящего буфера для канала.Gets the size, in bytes, of the outbound buffer for a pipe.

Position

Возвращает или задает текущую позицию в текущем потоке.Gets or sets the current position of the current stream.

ReadMode

Возвращает или задает режим чтения для объекта PipeStream.Gets or sets the reading mode for a PipeStream object.

ReadTimeout

Возвращает или задает значение в миллисекундах, определяющее период, в течение которого поток будет пытаться выполнить операцию чтения, прежде чем истечет время ожидания.Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.

(Унаследовано от Stream)
SafePipeHandle

Получает безопасный дескриптор для локального конца канала, инкапсулируемого текущим объектом PipeStream.Gets the safe handle for the local end of the pipe that the current PipeStream object encapsulates.

TransmissionMode

Возвращает режим передачи, поддерживаемый текущим каналом.Gets the pipe transmission mode supported by the current pipe.

WriteTimeout

Возвращает или задает значение в миллисекундах, определяющее период времени, отведенного потоку на выполнение операции записи.Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.

(Унаследовано от Stream)

Методы

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)

Начинает операцию асинхронного чтения.Begins an asynchronous read operation.

BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)

Начинает операцию асинхронной записи.Begins an asynchronous write operation.

CheckPipePropertyOperations()

Проверяет, допускает ли состояние канала получение или установку свойств.Verifies that the pipe is in a proper state for getting or setting properties.

CheckReadOperations()

Проверяет, находится ли канал в подключенном состоянии для выполнения операций чтения.Verifies that the pipe is in a connected state for read operations.

CheckWriteOperations()

Проверяет, находится ли канал в подключенном состоянии для выполнения операций записи.Verifies that the pipe is in a connected state for write operations.

Close()

Закрывает текущий поток и отключает все ресурсы (например, сокеты и файловые дескрипторы), связанные с текущим потоком.Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Вместо вызова данного метода, убедитесь в том, что поток надлежащим образом ликвидирован.Instead of calling this method, ensure that the stream is properly disposed.

(Унаследовано от Stream)
CopyTo(Stream)

Считывает байты из текущего потока и записывает их в другой поток.Reads the bytes from the current stream and writes them to another stream.

(Унаследовано от Stream)
CopyTo(Stream, Int32)

Считывает байты из текущего потока и записывает их в другой поток, используя указанный размер буфера.Reads the bytes from the current stream and writes them to another stream, using a specified buffer size.

(Унаследовано от Stream)
CopyToAsync(Stream)

Асинхронно считывает байты из текущего потока и записывает их в другой поток.Asynchronously reads the bytes from the current stream and writes them to another stream.

(Унаследовано от Stream)
CopyToAsync(Stream, CancellationToken)

Асинхронно считывает байты из текущего потока и записывает их в другой поток, используя указанный токен отмены.Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified cancellation token.

(Унаследовано от Stream)
CopyToAsync(Stream, Int32)

Асинхронно считывает байты из текущего потока и записывает их в другой поток, используя указанный размер буфера.Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size.

(Унаследовано от Stream)
CopyToAsync(Stream, Int32, CancellationToken)

Асинхронно считывает байты из текущего потока и записывает их в другой поток, используя указанный размер буфера и токен отмены.Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token.

(Унаследовано от Stream)
CreateObjRef(Type)

Создает объект, который содержит всю необходимую информацию для создания прокси-сервера, используемого для взаимодействия с удаленным объектом.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Унаследовано от MarshalByRefObject)
CreateWaitHandle()

Размещает объект WaitHandle.Allocates a WaitHandle object.

(Унаследовано от Stream)
Dispose()

Освобождает все ресурсы, занятые модулем Stream.Releases all resources used by the Stream.

(Унаследовано от Stream)
Dispose(Boolean)

Освобождает неуправляемые ресурсы, используемые классом PipeStream (при необходимости освобождает и управляемые ресурсы).Releases the unmanaged resources used by the PipeStream class and optionally releases the managed resources.

DisposeAsync()

Асинхронно освобождает неуправляемые ресурсы, используемые классом Stream.Asynchronously releases the unmanaged resources used by the Stream.

(Унаследовано от Stream)
EndRead(IAsyncResult)

Завершает отложенный запрос асинхронного чтения.Ends a pending asynchronous read request.

EndWrite(IAsyncResult)

Завершает отложенный запрос асинхронной записи.Ends a pending asynchronous write request.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
Flush()

Очищает буфер для текущего потока и вызывает запись всех буферизованных данных в соответствующее устройство.Clears the buffer for the current stream and causes any buffered data to be written to the underlying device.

FlushAsync()

Асинхронно очищает все буферы для этого потока и вызывает запись всех буферизованных данных в базовое устройство.Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.

(Унаследовано от Stream)
FlushAsync(CancellationToken)

Асинхронно очищает все буферы данного потока, вызывает запись буферизованных данных в базовое устройство и отслеживает запросы отмены.Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.

(Унаследовано от Stream)
GetAccessControl()

Получает объект PipeSecurity, который инкапсулирует записи списка управления доступом (ACL) для канала, описываемого текущим объектом PipeStream.Gets a PipeSecurity object that encapsulates the access control list (ACL) entries for the pipe described by the current PipeStream object.

GetHashCode()

Служит в качестве хэш-функции по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetLifetimeService()

Извлекает объект обслуживания во время существования, который управляет политикой времени существования данного экземпляра.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
InitializeHandle(SafePipeHandle, Boolean, Boolean)

Инициализирует объект PipeStream из указанного объекта SafePipeHandle.Initializes a PipeStream object from the specified SafePipeHandle object.

InitializeLifetimeService()

Получает объект службы времени существования для управления политикой времени существования для этого экземпляра.Obtains a lifetime service object to control the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
MemberwiseClone(Boolean)

Создает неполную копию текущего объекта MarshalByRefObject.Creates a shallow copy of the current MarshalByRefObject object.

(Унаследовано от MarshalByRefObject)
ObjectInvariant()

Обеспечивает поддержку для Contract.Provides support for a Contract.

(Унаследовано от Stream)
Read(Byte[], Int32, Int32)

Считывает блок байтов из потока и записывает данные в указанный буфер, начиная с заданной позиции с учетом указанной длины.Reads a block of bytes from a stream and writes the data to a specified buffer starting at a specified position for a specified length.

Read(Span<Byte>)

Считывает последовательность байтов из текущего потока, записывает их в массив байтов и перемещает позицию внутри потока на число считанных байтов.Reads a sequence of bytes from the current stream, writes them to a byte array, and advances the position within the stream by the number of bytes read.

ReadAsync(Byte[], Int32, Int32)

Асинхронно считывает последовательность байтов из текущего потока и перемещает позицию внутри потока на число считанных байтов.Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

(Унаследовано от Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)

Асинхронно считывает последовательность байтов из текущего потока в массив байтов, начиная с указанной позиции, с учетом указанного числа байтов, перемещает позицию в потоке на число считанных байтов и отслеживает запросы отмены.Asynchronously reads a sequence of bytes from the current stream to a byte array starting at a specified position for a specified number of bytes, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

ReadAsync(Memory<Byte>, CancellationToken)

Асинхронно считывает последовательность байтов из текущего потока, записывает их в диапазон памяти байтов, перемещает позицию в потоке на число считанных байтов и отслеживает запросы отмены.Asynchronously reads a sequence of bytes from the current stream, writes them to a byte memory range, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

ReadByte()

Считывает байт из канала.Reads a byte from a pipe.

Seek(Int64, SeekOrigin)

Устанавливает заданное значение в качестве текущей позиции в текущем потоке.Sets the current position of the current stream to the specified value.

SetAccessControl(PipeSecurity)

Применяет записи списка управления доступом (ACL), заданные объектом PipeSecurity, к каналу, заданному текущим объектом PipeStream.Applies the access control list (ACL) entries specified by a PipeSecurity object to the pipe specified by the current PipeStream object.

SetLength(Int64)

Задает указанное значение для длины текущего потока.Sets the length of the current stream to the specified value.

ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)
WaitForPipeDrain()

Ожидает завершения считывания всех отправленных байтов на противоположном конце канала.Waits for the other end of the pipe to read all sent bytes.

Write(Byte[], Int32, Int32)

Записывает в текущий поток блок байтов, используя данные из буфера.Writes a block of bytes to the current stream using data from a buffer.

Write(ReadOnlySpan<Byte>)

Записывает последовательность байтов в текущий поток и перемещает текущую позицию внутри потока на число записанных байтов.Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

WriteAsync(Byte[], Int32, Int32)

Асинхронно записывает последовательность байтов в текущий поток и перемещает текущую позицию внутри потока на число записанных байтов.Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

(Унаследовано от Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)

Асинхронно записывает указанное число байтов из текущего потока в массив байтов, начиная с указанной позиции, перемещает позицию в потоке на число считанных байтов и отслеживает запросы отмены.Asynchronously writes a specified number of bytes from a byte array starting at a specified position, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Асинхронно записывает последовательность байтов в текущий поток, перемещает текущую позицию внутри потока на число записанных байтов и отслеживает запросы отмены.Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

WriteByte(Byte)

Выполняет запись байта в текущий поток.Writes a byte to the current stream.

Явные реализации интерфейса

IDisposable.Dispose()

Освобождает все ресурсы, занятые модулем Stream.Releases all resources used by the Stream.

(Унаследовано от Stream)

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

GetAccessControl(PipeStream)

Возвращает сведения о безопасности для потока канала.Returns the security information of a pipe stream.

SetAccessControl(PipeStream, PipeSecurity)

Изменяет атрибуты безопасности для существующего потока канала.Changes the security attributes of an existing pipe stream.

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