NamedPipeClientStream Classe

Definição

Namespace:

System.IO.Pipes

Assembly:

System.IO.Pipes.dll

Origem:

NamedPipeClientStream.cs

Expõe um Stream em torno de um pipe nomeado, que dá suporte a operações de leitura e gravação síncronas e assíncronas.

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

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

type NamedPipeClientStream = class
    inherit PipeStream

Public NotInheritable Class NamedPipeClientStream
Inherits PipeStream

Herança

Object

MarshalByRefObject

Stream

PipeStream

NamedPipeClientStream

Exemplos

O exemplo a seguir demonstra uma maneira de enviar uma cadeia de caracteres de um processo pai para um processo filho no mesmo computador usando pipes nomeados. Este exemplo cria um NamedPipeServerStream objeto em um processo pai. O NamedPipeServerStream objeto tem um PipeDirection valor de Out. Em seguida, o servidor aguarda um NamedPipeClientStream objeto em um processo filho se conectar a ele. Neste exemplo, ambos os processos estão no mesmo computador e o NamedPipeClientStream objeto tem um PipeDirection valor de In. Em seguida, o processo pai envia uma cadeia de caracteres fornecida pelo usuário ao processo filho. A cadeia de caracteres é exibida no console.

Este exemplo é para o processo do cliente, que se conecta ao processo do servidor. Para obter todo o exemplo de código, incluindo o código para o cliente de pipe e o servidor, consulte Como usar pipes nomeados para comunicação entre processos de rede.

using System;
using System.IO;
using System.IO.Pipes;

class PipeClient
{
    static void Main(string[] args)
    {
        using (NamedPipeClientStream pipeClient =
            new NamedPipeClientStream(".", "testpipe", PipeDirection.In))
        {

            // Connect to the pipe or wait until the pipe is available.
            Console.Write("Attempting to connect to pipe...");
            pipeClient.Connect();

            Console.WriteLine("Connected to pipe.");
            Console.WriteLine("There are currently {0} pipe server instances open.",
               pipeClient.NumberOfServerInstances);
            using (StreamReader sr = new StreamReader(pipeClient))
            {
                // Display the read text to the console
                string temp;
                while ((temp = sr.ReadLine()) != null)
                {
                    Console.WriteLine("Received from server: {0}", temp);
                }
            }
        }
        Console.Write("Press Enter to continue...");
        Console.ReadLine();
    }
}

Imports System.IO
Imports System.IO.Pipes
Imports System.Security.Principal

Class PipeClient

    Shared Sub Main(ByVal args As String())

        Dim pipeClient As New NamedPipeClientStream("localhost", _
                    "testpipe", PipeDirection.In, PipeOptions.None)

        ' Connect to the pipe or wait until the pipe is available.
        Console.WriteLine("Attempting to connect to the pipe...")
        pipeClient.Connect()

        Console.WriteLine("Connect to the pipe.")
        Console.WriteLine("There are currently {0} pipe server instances open.", _
                          pipeClient.NumberOfServerInstances)

        Dim sr As New StreamReader(pipeClient)
        Dim temp As String

        temp = sr.ReadLine()
        While Not temp Is Nothing
            Console.WriteLine("Received from server: {0}", temp)
            temp = sr.ReadLine()
        End While
        Console.Write("Press Enter to continue...")
        Console.ReadLine()
    End Sub
End Class

Comentários

Os pipes nomeados fornecem pipes unidirecionais ou duplex para comunicação entre um servidor de pipe e um ou mais clientes de pipe. Pipes nomeados podem ser usados para comunicação entre processos localmente ou por uma rede. Um único nome de pipe pode ser compartilhado por vários NamedPipeClientStream objetos.

Qualquer processo pode atuar como um servidor de pipe nomeado ou cliente ou ambos.

Construtores

NamedPipeClientStream(PipeDirection, Boolean, Boolean, SafePipeHandle)	Inicializa uma nova instância da classe NamedPipeClientStream para o identificador de pipe especificado com a direção de pipe especificada.
NamedPipeClientStream(String)	Inicializa uma nova instância da classe NamedPipeClientStream com o nome do pipe especificado.
NamedPipeClientStream(String, String)	Inicializa uma nova instância da classe NamedPipeClientStream com os nomes de pipe e servidor especificados.
NamedPipeClientStream(String, String, PipeDirection)	Inicializa uma nova instância da classe NamedPipeClientStream com os nomes de pipe e servidor especificados e a direção de pipe especificada.
NamedPipeClientStream(String, String, PipeDirection, PipeOptions)	Inicializa uma nova instância da classe NamedPipeClientStream com os nomes de pipe e servidor especificados, além das opções de pipe e direção de pipe especificadas.
NamedPipeClientStream(String, String, PipeDirection, PipeOptions, TokenImpersonationLevel)	Inicializa uma nova instância da classe NamedPipeClientStream com os nomes de pipe e servidor especificados, a direção de pipe especificada, as opções de pipe e o nível de representação de segurança.
NamedPipeClientStream(String, String, PipeDirection, PipeOptions, TokenImpersonationLevel, HandleInheritability)	Inicializa uma nova instância da classe NamedPipeClientStream com os nomes de pipe e de servidor especificados e a direção do pipe, as opções de pipe, o nível de representação de segurança e o modo de capacidade de herança especificados.

Propriedades

CanRead	Obtém um valor que indica se o fluxo atual dá suporte a operações de leitura. (Herdado de PipeStream)
CanSeek	Obtém um valor que indica se o fluxo atual dá suporte a operações de espiada. (Herdado de PipeStream)
CanTimeout	Obtém um valor que determina se o fluxo atual pode atingir o tempo limite. (Herdado de Stream)
CanWrite	Obtém um valor que indica se o fluxo atual dá suporte a operações de gravação. (Herdado de PipeStream)
InBufferSize	Obtém o tamanho, em bytes, do buffer de entrada para um pipe. (Herdado de PipeStream)
IsAsync	Obtém um valor que indica se um objeto PipeStream foi aberto de maneira assíncrona ou síncrona. (Herdado de PipeStream)
IsConnected	Obtém ou define um valor que indica se um objeto PipeStream está conectado. (Herdado de PipeStream)
IsHandleExposed	Obtém um valor que indica se um identificador para um objeto PipeStream é exposto. (Herdado de PipeStream)
IsMessageComplete	Obtém um valor que indica se há mais dados na mensagem retornada da operação de leitura mais recente. (Herdado de PipeStream)
Length	Obtém o comprimento de um fluxo, em bytes. (Herdado de PipeStream)
NumberOfServerInstances	Obtém o número de instâncias de servidor que compartilham o mesmo nome de pipe.
OutBufferSize	Obtém o tamanho, em bytes, do buffer de saída para um pipe. (Herdado de PipeStream)
Position	Obtém ou define a posição atual do fluxo atual. (Herdado de PipeStream)
ReadMode	Obtém ou define o modo de leitura para um objeto PipeStream. (Herdado de PipeStream)
ReadTimeout	Obtém ou define um valor, em milissegundos, que determina por quanto tempo o fluxo tentará realizar a leitura antes do tempo limite. (Herdado de Stream)
SafePipeHandle	Obtém o identificador seguro para a extremidade local do pipe encapsulado pelo objeto PipeStream atual. (Herdado de PipeStream)
TransmissionMode	Obtém o modo de transmissão de pipe para o qual o pipe atual dá suporte. (Herdado de PipeStream)
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. (Herdado de Stream)

Métodos

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Inicia uma operação de leitura assíncrona. (Herdado de PipeStream)
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Inicia uma operação de gravação assíncrona. (Herdado de PipeStream)
CheckPipePropertyOperations()	Verifica se o pipe está no estado correto para obter ou definir propriedades. (Herdado de PipeStream)
CheckReadOperations()	Verifica se o pipe está em um estado conectado para operações de leitura. (Herdado de PipeStream)
CheckWriteOperations()	Verifica se o pipe está em um estado conectado para operações de gravação. (Herdado de PipeStream)
Close()	Fecha o fluxo atual e libera todos os recursos (como soquetes e identificadores de arquivos) associados ao fluxo atual. Em vez de chamar esse método, verifique se o fluxo é descartado corretamente. (Herdado de Stream)
Connect()	Conecta a um servidor de espera com um valor de tempo limite infinito.
Connect(Int32)	Conecta a um servidor de espera dentro do período de tempo limite especificado.
Connect(TimeSpan)	Conecta-se a um servidor de espera dentro do período de tempo limite especificado.
ConnectAsync()	Conecta-se de maneira assíncrona a um servidor de espera com um período de tempo limite infinito.
ConnectAsync(CancellationToken)	Conecta-se de maneira assíncrona a um servidor em espera e monitora solicitações de cancelamento.
ConnectAsync(Int32)	Conecta-se de maneira assíncrona a um servidor de espera dentro do período de tempo limite especificado.
ConnectAsync(Int32, CancellationToken)	Conecta-se de maneira assíncrona a um servidor de espera no período de tempo limite especificado e monitora solicitações de cancelamento.
ConnectAsync(TimeSpan, CancellationToken)	Conecta-se de maneira assíncrona a um servidor de espera no período de tempo limite especificado e monitora solicitações de cancelamento.
CopyTo(Stream)	Lê os bytes do fluxo atual e os grava em outro fluxo. Ambas as posições de fluxo são avançadas pelo número de bytes copiados. (Herdado de Stream)
CopyTo(Stream, Int32)	Lê os bytes do fluxo atual e os grava em outro fluxo usando um tamanho do buffer especificado. Ambas as posições de fluxo são avançadas pelo número de bytes copiados. (Herdado de Stream)
CopyToAsync(Stream)	Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo. Ambas as posições de fluxo são avançadas pelo número de bytes copiados. (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. Ambas as posições de fluxo são avançadas pelo número de bytes copiados. (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. Ambas as posições de fluxo são avançadas pelo número de bytes copiados. (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. Ambas as posições de fluxo são avançadas pelo número de bytes copiados. (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. (Herdado de MarshalByRefObject)
CreateWaitHandle()	Obsoleto. Aloca um objeto WaitHandle. (Herdado de Stream)
Dispose()	Libera todos os recursos usados pelo Stream. (Herdado de Stream)
Dispose(Boolean)	Libera os recursos não gerenciados usados pela classe PipeStream e, opcionalmente, libera os recursos gerenciados. (Herdado de PipeStream)
DisposeAsync()	Libera de forma assíncrona os recursos não gerenciados usados pelo Stream. (Herdado de Stream)
EndRead(IAsyncResult)	Encerra uma solicitação de leitura assíncrona pendente. (Herdado de PipeStream)
EndWrite(IAsyncResult)	Encerra uma solicitação de gravação assíncrona pendente. (Herdado de PipeStream)
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
Finalize()	Libera recursos não gerenciados e executa outras operações de limpeza antes que a instância NamedPipeClientStream seja recuperada pela coleta de lixo.
Flush()	Limpa o buffer para o fluxo atual e faz com que todos os dados armazenados em buffer sejam gravados no dispositivo subjacente. (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. (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. (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. (Herdado de PipeStream)
GetHashCode()	Serve como a função de hash padrão. (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. (Herdado de MarshalByRefObject)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
InitializeHandle(SafePipeHandle, Boolean, Boolean)	Inicializa um objeto PipeStream usando o objeto SafePipeHandle especificado. (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. (Herdado de MarshalByRefObject)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
MemberwiseClone(Boolean)	Cria uma cópia superficial do objeto MarshalByRefObject atual. (Herdado de MarshalByRefObject)
ObjectInvariant()	Obsoleto. Oferece suporte a um 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. (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. (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. (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. (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. (Herdado de PipeStream)
ReadAtLeast(Span<Byte>, Int32, Boolean)	Lê pelo menos um número mínimo de bytes do fluxo atual e avança a posição dentro do fluxo pelo número de bytes lidos. (Herdado de Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Lê de forma assíncrona pelo menos um número mínimo de bytes do fluxo atual, avança a posição dentro do fluxo pelo número de bytes lidos e monitora solicitações de cancelamento. (Herdado de Stream)
ReadByte()	Lê um byte de um pipe. (Herdado de PipeStream)
ReadExactly(Byte[], Int32, Int32)	Lê count o número de bytes do fluxo atual e avança a posição dentro do fluxo. (Herdado de Stream)
ReadExactly(Span<Byte>)	Lê bytes do fluxo atual e avança a posição dentro do fluxo até que o buffer seja preenchido. (Herdado de Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	Lê count de forma assíncrona o número de bytes do fluxo atual, avança a posição dentro do fluxo e monitora as solicitações de cancelamento. (Herdado de Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	Lê bytes de forma assíncrona do fluxo atual, avança a posição dentro do fluxo até que o buffer seja preenchido e monitora solicitações de cancelamento. (Herdado de Stream)
Seek(Int64, SeekOrigin)	Define a posição atual do fluxo atual para o valor especificado. (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. (Herdado de PipeStream)
SetLength(Int64)	Define o comprimento do fluxo atual para o valor especificado. (Herdado de PipeStream)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)
WaitForPipeDrain()	Aguarda até que o outro participante do pipe leia todos os bytes enviados. (Herdado de PipeStream)
Write(Byte[], Int32, Int32)	Grava um bloco de bytes no fluxo atual usando os dados de um 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. (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. (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. (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. (Herdado de PipeStream)
WriteByte(Byte)	Grava um byte no fluxo atual. (Herdado de PipeStream)

Métodos de Extensão

GetAccessControl(PipeStream)	Retorna as informações de segurança de um fluxo de pipe.
SetAccessControl(PipeStream, PipeSecurity)	Altera os atributos de segurança de um fluxo de pipe existente.
ConfigureAwait(IAsyncDisposable, Boolean)	Configura como as esperas nas tarefas retornadas de um descartável assíncrono são realizadas.