AnonymousPipeClientStream Classe

Definição

Expõe o lado do cliente de um fluxo de pipe anônimo que dá suporte a operações de leitura e gravação síncronas e assíncronas.Exposes the client side of an anonymous pipe stream, which supports both synchronous and asynchronous read and write operations.

public ref class AnonymousPipeClientStream sealed : System::IO::Pipes::PipeStream
public sealed class AnonymousPipeClientStream : System.IO.Pipes.PipeStream
type AnonymousPipeClientStream = class
    inherit PipeStream
Public NotInheritable Class AnonymousPipeClientStream
Inherits PipeStream
Herança
AnonymousPipeClientStream
Herança
AnonymousPipeClientStream

Exemplos

O exemplo a seguir envia uma cadeia de caracteres de um processo pai para um processo filho usando pipes anônimos.The following example sends a string from a parent process to a child process by using anonymous pipes. Este exemplo cria um objeto AnonymousPipeServerStream em um processo pai com um valor PipeDirection de Out.This example creates an AnonymousPipeServerStream object in a parent process with a PipeDirection value of Out. Ele também cria um AnonymousPipeClientStream objeto em um processo filho com um PipeDirection valor de In .It also creates an AnonymousPipeClientStream object in a child process with a PipeDirection value of In. Em seguida, o processo pai envia uma cadeia de caracteres fornecida pelo usuário ao processo filho.The parent process then sends a user-supplied string to the child process. A cadeia de caracteres é exibida para o console.The string is displayed to the console.

Este exemplo é para o processo do cliente, que é iniciado pelo processo do servidor.This example is for the client process, which is started by the server process. Nomeie o executável resultante do código do cliente pipeClient.exe e copie-o para o mesmo diretório que o executável do servidor ao executar este exemplo.Name the resulting executable from the client code pipeClient.exe and copy it to the same directory as the server executable when you run this example. Para o exemplo de código inteiro, incluindo o código para o cliente e o servidor do pipe, consulte como usar pipes anônimos para comunicação entre processos locais.For the entire code example, including the code for both the pipe client and server, see How to: Use Anonymous Pipes for Local Interprocess Communication.

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

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

ref class PipeClient
{
public:
    static void Main(array<String^>^ args)
    {
        if (args->Length > 1)
        {
            PipeStream^ pipeClient = gcnew AnonymousPipeClientStream(PipeDirection::In, args[1]);

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

            StreamReader^ sr = gcnew StreamReader(pipeClient);

            // Display the read text to the console
            String^ temp;

            // Wait for 'sync message' from the server.
            do
            {
                Console::WriteLine("[CLIENT] Wait for sync...");
                temp = sr->ReadLine();
            }
            while (!temp->StartsWith("SYNC"));

            // Read the server data and echo to the console.
            while ((temp = sr->ReadLine()) != nullptr)
            {
                Console::WriteLine("[CLIENT] Echo: " + temp);
            }
            sr->Close();
            pipeClient->Close();
        }
        Console::Write("[CLIENT] Press Enter to continue...");
        Console::ReadLine();
    }
};

int main()
{
    array<String^>^ args = Environment::GetCommandLineArgs();
    PipeClient::Main(args);
}
//</snippet01>
//<snippet01>
using System;
using System.IO;
using System.IO.Pipes;

class PipeClient
{
    static void Main(string[] args)
    {
        if (args.Length > 0)
        {
            using (PipeStream pipeClient =
                new AnonymousPipeClientStream(PipeDirection.In, args[0]))
            {
                Console.WriteLine("[CLIENT] Current TransmissionMode: {0}.",
                   pipeClient.TransmissionMode);

                using (StreamReader sr = new StreamReader(pipeClient))
                {
                    // Display the read text to the console
                    string temp;

                    // Wait for 'sync message' from the server.
                    do
                    {
                        Console.WriteLine("[CLIENT] Wait for sync...");
                        temp = sr.ReadLine();
                    }
                    while (!temp.StartsWith("SYNC"));

                    // Read the server data and echo to the console.
                    while ((temp = sr.ReadLine()) != null)
                    {
                        Console.WriteLine("[CLIENT] Echo: " + temp);
                    }
                }
            }
        }
        Console.Write("[CLIENT] Press Enter to continue...");
        Console.ReadLine();
    }
}
//</snippet01>
'<snippet01>
Imports System.IO
Imports System.IO.Pipes

Class PipeClient
    Shared Sub Main(args() as String)
        If args.Length > 0 Then
            Using pipeClient As New AnonymousPipeClientStream(PipeDirection.In, args(0))
                Console.WriteLine("[CLIENT] Current TransmissionMode: {0}.", _
                   pipeClient.TransmissionMode)

                Using sr As New StreamReader(pipeClient)
                    ' Display the read text to the console
                    Dim temp As String

                    ' Wait for 'sync message' from the server.
                    Do
                        Console.WriteLine("[CLIENT] Wait for sync...")
                        temp = sr.ReadLine()
                    Loop While temp.StartsWith("SYNC") = False

                    ' Read the server data and echo to the console.
                    temp = sr.ReadLine()
                    While Not temp = Nothing
                        Console.WriteLine("[CLIENT] Echo: " + temp)
                        temp = sr.ReadLine()
                    End While
                End Using
            End Using
        End If
        Console.Write("[CLIENT] Press Enter to continue...")
        Console.ReadLine()
    End Sub
End Class
'</snippet01>

Comentários

Os pipes anônimos ajudam a fornecer comunicação segura e segura entre processos entre os processos filho e pai.Anonymous pipes help provide safe and secure interprocess communication between child and parent processes. A AnonymousPipeClientStream classe permite que um processo filho se conecte e troque informações com um processo pai.The AnonymousPipeClientStream class enables a child process to connect to and exchange information with a parent process.

Pipes anônimos são pipes unidirecionais sem nome, que normalmente transferem dados entre processos pai e filho.Anonymous pipes are unnamed, one-way pipes that typically transfer data between parent and child processes. Os pipes anônimos são sempre locais; Eles não podem ser usados em uma rede.Anonymous pipes are always local; they cannot be used over a network. Um PipeDirection valor de InOut não tem suporte porque Pipes anônimos são definidos como unidirecional.A PipeDirection value of InOut is not supported because anonymous pipes are defined to be one-way.

Pipes anônimos não dão suporte ao PipeTransmissionMode.Message modo de leitura.Anonymous pipes do not support the PipeTransmissionMode.Message read mode.

O lado do cliente de um pipe anônimo deve ser criado a partir de um identificador de pipe fornecido pelo lado do servidor chamando o GetClientHandleAsString método.The client side of an anonymous pipe must be created from a pipe handle provided by the server side by calling the GetClientHandleAsString method. Em seguida, a cadeia de caracteres é passada como um parâmetro ao criar o processo do cliente.The string is then passed as a parameter when creating the client process. A partir do processo do cliente, ele é passado para o AnonymousPipeClientStream Construtor como o pipeHandleAsString parâmetro.From the client process, it is passed to the AnonymousPipeClientStream constructor as the pipeHandleAsString parameter.

Construtores

AnonymousPipeClientStream(PipeDirection, SafePipeHandle)

Inicializa uma nova instância da classe AnonymousPipeClientStream do identificador especificado.Initializes a new instance of the AnonymousPipeClientStream class from the specified handle.

AnonymousPipeClientStream(PipeDirection, String)

Inicializa uma nova instância da classe AnonymousPipeClientStream com a direção do pipe especificada e uma representação de cadeia de caracteres do identificador do pipe.Initializes a new instance of the AnonymousPipeClientStream class with the specified pipe direction and a string representation of the pipe handle.

AnonymousPipeClientStream(String)

Inicializa uma nova instância da classe AnonymousPipeClientStream com a representação especificada da cadeia de caracteres do identificador do pipe.Initializes a new instance of the AnonymousPipeClientStream class with the specified string representation of the pipe handle.

Propriedades

CanRead

Obtém um valor que indica se o fluxo atual dá suporte a operações de leitura.Gets a value indicating whether the current stream supports read operations.

(Herdado de PipeStream)
CanSeek

Obtém um valor que indica se o fluxo atual dá suporte a operações de espiada.Gets a value indicating whether the current stream supports seek operations.

(Herdado de PipeStream)
CanTimeout

Obtém um valor que determina se o fluxo atual pode atingir o tempo limite.Gets a value that determines whether the current stream can time out.

(Herdado de Stream)
CanWrite

Obtém um valor que indica se o fluxo atual dá suporte a operações de gravação.Gets a value indicating whether the current stream supports write operations.

(Herdado de PipeStream)
InBufferSize

Obtém o tamanho, em bytes, do buffer de entrada para um pipe.Gets the size, in bytes, of the inbound buffer for a pipe.

(Herdado de PipeStream)
IsAsync

Obtém um valor que indica se um objeto PipeStream foi aberto de maneira assíncrona ou síncrona.Gets a value indicating whether a PipeStream object was opened asynchronously or synchronously.

(Herdado de PipeStream)
IsConnected

Obtém ou define um valor que indica se um objeto PipeStream está conectado.Gets or sets a value indicating whether a PipeStream object is connected.

(Herdado de PipeStream)
IsHandleExposed

Obtém um valor que indica se um identificador para um objeto PipeStream é exposto.Gets a value indicating whether a handle to a PipeStream object is exposed.

(Herdado de PipeStream)
IsMessageComplete

Obtém um valor que indica se há mais dados na mensagem retornada da operação de leitura mais recente.Gets a value indicating whether there is more data in the message returned from the most recent read operation.

(Herdado de PipeStream)
Length

Obtém o comprimento de um fluxo, em bytes.Gets the length of a stream, in bytes.

(Herdado de PipeStream)
OutBufferSize

Obtém o tamanho, em bytes, do buffer de saída para um pipe.Gets the size, in bytes, of the outbound buffer for a pipe.

(Herdado de PipeStream)
Position

Obtém ou define a posição atual do fluxo atual.Gets or sets the current position of the current stream.

(Herdado de PipeStream)
ReadMode

Define o modo de leitura para o objeto AnonymousPipeClientStream.Sets the reading mode for the AnonymousPipeClientStream object.

ReadTimeout

Obtém ou define um valor, em milissegundos, que determina por quanto tempo o fluxo tentará realizar a leitura antes do tempo limite.Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.

(Herdado de Stream)
SafePipeHandle

Obtém o identificador seguro para a extremidade local do pipe encapsulado pelo objeto PipeStream atual.Gets the safe handle for the local end of the pipe that the current PipeStream object encapsulates.

(Herdado de PipeStream)
TransmissionMode

Obtém o modo de transmissão de pipe para o qual o pipe atual dá suporte.Gets the pipe transmission mode supported by the current pipe.

WriteTimeout

Obtém ou define um valor, em milissegundos, que determina por quanto tempo o fluxo tentará realizar a gravação antes do tempo limite.Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.

(Herdado de Stream)

Métodos

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

Inicia uma operação de leitura assíncrona.Begins an asynchronous read operation.

(Herdado de PipeStream)
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)

Inicia uma operação de gravação assíncrona.Begins an asynchronous write operation.

(Herdado de PipeStream)
CheckPipePropertyOperations()

Verifica se o pipe está no estado correto para obter ou definir propriedades.Verifies that the pipe is in a proper state for getting or setting properties.

(Herdado de PipeStream)
CheckReadOperations()

Verifica se o pipe está em um estado conectado para operações de leitura.Verifies that the pipe is in a connected state for read operations.

(Herdado de PipeStream)
CheckWriteOperations()

Verifica se o pipe está em um estado conectado para operações de gravação.Verifies that the pipe is in a connected state for write operations.

(Herdado de PipeStream)
Close()

Fecha o fluxo atual e libera todos os recursos (como soquetes e identificadores de arquivos) associados ao fluxo atual.Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Em vez de chamar esse método, verifique se o fluxo é descartado corretamente.Instead of calling this method, ensure that the stream is properly disposed.

(Herdado de Stream)
CopyTo(Stream)

Lê os bytes do fluxo atual e os grava em outro fluxo.Reads the bytes from the current stream and writes them to another stream.

(Herdado de Stream)
CopyTo(Stream, Int32)

Lê os bytes do fluxo atual e os grava em outro fluxo usando um tamanho do buffer especificado.Reads the bytes from the current stream and writes them to another stream, using a specified buffer size.

(Herdado de Stream)
CopyToAsync(Stream)

Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo.Asynchronously reads the bytes from the current stream and writes them to another stream.

(Herdado de Stream)
CopyToAsync(Stream, CancellationToken)

Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo usando um token de cancelamento especificado.Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified cancellation token.

(Herdado de Stream)
CopyToAsync(Stream, Int32)

Lê de maneira assíncrona os bytes do fluxo atual e os grava em outro fluxo usando um tamanho do buffer especificado.Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size.

(Herdado de Stream)
CopyToAsync(Stream, Int32, CancellationToken)

Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo usando um tamanho do buffer especificado e um token de cancelamento.Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token.

(Herdado de Stream)
CreateObjRef(Type)

Cria um objeto que contém todas as informações relevantes necessárias para gerar um proxy usado para se comunicar com um objeto remoto.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Herdado de MarshalByRefObject)
CreateWaitHandle()
Obsoleto.

Aloca um objeto WaitHandle.Allocates a WaitHandle object.

(Herdado de Stream)
Dispose()

Libera todos os recursos usados pelo Stream.Releases all resources used by the Stream.

(Herdado de Stream)
Dispose(Boolean)

Libera os recursos não gerenciados usados pela classe PipeStream e, opcionalmente, libera os recursos gerenciados.Releases the unmanaged resources used by the PipeStream class and optionally releases the managed resources.

(Herdado de PipeStream)
DisposeAsync()

Libera de forma assíncrona os recursos não gerenciados usados pelo Stream.Asynchronously releases the unmanaged resources used by the Stream.

(Herdado de Stream)
EndRead(IAsyncResult)

Encerra uma solicitação de leitura assíncrona pendente.Ends a pending asynchronous read request.

(Herdado de PipeStream)
EndWrite(IAsyncResult)

Encerra uma solicitação de gravação assíncrona pendente.Ends a pending asynchronous write request.

(Herdado de PipeStream)
Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.Determines whether the specified object is equal to the current object.

(Herdado de Object)
Finalize()

Libera recursos não gerenciados e executa outras operações de limpeza antes que a instância AnonymousPipeClientStream seja recuperada pela coleta de lixo.Releases unmanaged resources and performs other cleanup operations before the AnonymousPipeClientStream instance is reclaimed by garbage collection.

Flush()

Limpa o buffer para o fluxo atual e faz com que todos os dados armazenados em buffer sejam gravados no dispositivo subjacente.Clears the buffer for the current stream and causes any buffered data to be written to the underlying device.

(Herdado de PipeStream)
FlushAsync()

Limpa de forma assíncrona todos os buffers nesse fluxo e faz com que os dados armazenados em buffer sejam gravados no dispositivo subjacente.Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.

(Herdado de Stream)
FlushAsync(CancellationToken)

Limpa de modo assíncrono o buffer para o fluxo atual e faz com que todos os dados armazenados em buffer sejam gravados no dispositivo subjacente.Asynchronously clears the buffer for the current stream and causes any buffered data to be written to the underlying device.

(Herdado de PipeStream)
GetAccessControl()

Obtém um objeto PipeSecurity que encapsula as entradas da ACL (lista de controle de acesso) para o pipe descrito pelo objeto PipeStream atual.Gets a PipeSecurity object that encapsulates the access control list (ACL) entries for the pipe described by the current PipeStream object.

(Herdado de PipeStream)
GetHashCode()

Serve como a função de hash padrão.Serves as the default hash function.

(Herdado de Object)
GetLifetimeService()
Obsoleto.

Recupera o objeto de serviço de tempo de vida atual que controla a política de ciclo de vida para esta instância.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Herdado de MarshalByRefObject)
GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Herdado de Object)
InitializeHandle(SafePipeHandle, Boolean, Boolean)

Inicializa um objeto PipeStream usando o objeto SafePipeHandle especificado.Initializes a PipeStream object from the specified SafePipeHandle object.

(Herdado de PipeStream)
InitializeLifetimeService()
Obsoleto.

Obtém um objeto de serviço de tempo de vida para controlar a política de tempo de vida para essa instância.Obtains a lifetime service object to control the lifetime policy for this instance.

(Herdado de MarshalByRefObject)
MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Herdado de Object)
MemberwiseClone(Boolean)

Cria uma cópia superficial do objeto MarshalByRefObject atual.Creates a shallow copy of the current MarshalByRefObject object.

(Herdado de MarshalByRefObject)
ObjectInvariant()
Obsoleto.

Oferece suporte a um Contract.Provides support for a Contract.

(Herdado de Stream)
Read(Byte[], Int32, Int32)

Lê um bloco de bytes de um fluxo e grava os dados em um buffer especificado, começando em uma posição especificada para um tamanho especificado.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.

(Herdado de PipeStream)
Read(Span<Byte>)

Lê uma sequência de bytes do fluxo em buffer atual, grava-os em uma matriz de bytes e avança a posição no fluxo até o número de bytes lidos.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.

(Herdado de PipeStream)
ReadAsync(Byte[], Int32, Int32)

Lê uma sequência de bytes do fluxo atual de forma assíncrona e avança a posição no fluxo até o número de bytes lidos.Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

(Herdado de Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)

Lê de forma assíncrona uma sequência de bytes do fluxo em buffer atual para uma matriz de bytes começando em uma posição especificada de um número especificado de bytes, avança a posição no fluxo até o número de bytes lidos e monitora as solicitações de cancelamento.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.

(Herdado de PipeStream)
ReadAsync(Memory<Byte>, CancellationToken)

Lê de forma assíncrona uma sequência de bytes do fluxo em buffer atual, grava-os em um intervalo de memória de bytes, avança a posição no fluxo até o número de bytes lidos e monitora as solicitações de cancelamento.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.

(Herdado de PipeStream)
ReadByte()

Lê um byte de um pipe.Reads a byte from a pipe.

(Herdado de PipeStream)
Seek(Int64, SeekOrigin)

Define a posição atual do fluxo atual para o valor especificado.Sets the current position of the current stream to the specified value.

(Herdado de PipeStream)
SetAccessControl(PipeSecurity)

Aplica as entradas de ACL (lista de controle de acesso) especificadas por um objeto PipeSecurity ao pipe especificado pelo objeto PipeStream atual.Applies the access control list (ACL) entries specified by a PipeSecurity object to the pipe specified by the current PipeStream object.

(Herdado de PipeStream)
SetLength(Int64)

Define o comprimento do fluxo atual para o valor especificado.Sets the length of the current stream to the specified value.

(Herdado de PipeStream)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Herdado de Object)
WaitForPipeDrain()

Aguarda até que o outro participante do pipe leia todos os bytes enviados.Waits for the other end of the pipe to read all sent bytes.

(Herdado de PipeStream)
Write(Byte[], Int32, Int32)

Grava um bloco de bytes no fluxo atual usando os dados de um buffer.Writes a block of bytes to the current stream using data from a buffer.

(Herdado de PipeStream)
Write(ReadOnlySpan<Byte>)

Grava uma sequência de bytes no fluxo atual e avança a posição atual dentro desse fluxo pelo número de bytes gravados.Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

(Herdado de PipeStream)
WriteAsync(Byte[], Int32, Int32)

Grava assincronamente uma sequência de bytes no fluxo atual e avança a posição atual dentro desse fluxo no número de bytes gravados.Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

(Herdado de Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)

Grava de forma assíncrona um número especificado de bytes de uma matriz de bytes começando em uma posição especificada, avança a posição atual nesse fluxo até o número de bytes gravados e monitora solicitações de cancelamento.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.

(Herdado de PipeStream)
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Grava uma sequência de bytes no fluxo atual assincronamente, avança a posição atual dentro desse fluxo pelo número de bytes gravados e monitora as solicitações de cancelamento.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.

(Herdado de PipeStream)
WriteByte(Byte)

Grava um byte no fluxo atual.Writes a byte to the current stream.

(Herdado de PipeStream)

Implantações explícitas de interface

IDisposable.Dispose()

Libera todos os recursos usados pelo Stream.Releases all resources used by the Stream.

(Herdado de Stream)

Métodos de Extensão

GetAccessControl(PipeStream)

Retorna as informações de segurança de um fluxo de pipe.Returns the security information of a pipe stream.

SetAccessControl(PipeStream, PipeSecurity)

Altera os atributos de segurança de um fluxo de pipe existente.Changes the security attributes of an existing pipe stream.

ConfigureAwait(IAsyncDisposable, Boolean)

Configura como as esperas nas tarefas retornadas de um descartável assíncrono são realizadas.Configures how awaits on the tasks returned from an async disposable are performed.

Aplica-se a