NamedPipeServerStream Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Expõe um Stream pipe em torno de um pipe nomeado, dando suporte a operações de leitura e gravação síncronas e assíncronas.
public ref class NamedPipeServerStream sealed : System::IO::Pipes::PipeStreampublic sealed class NamedPipeServerStream : System.IO.Pipes.PipeStreamtype NamedPipeServerStream = class
inherit PipeStreamPublic NotInheritable Class NamedPipeServerStream
Inherits PipeStream- Herança
- Herança
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 com 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 para o processo filho. A cadeia de caracteres é exibida no console.
Este exemplo é para o processo do servidor, que usa a NamedPipeServerStream classe. 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 de interprocesso de rede.
using System;
using System.IO;
using System.IO.Pipes;
class PipeServer
{
static void Main()
{
using (NamedPipeServerStream pipeServer =
new NamedPipeServerStream("testpipe", PipeDirection.Out))
{
Console.WriteLine("NamedPipeServerStream object created.");
// Wait for a client to connect
Console.Write("Waiting for client connection...");
pipeServer.WaitForConnection();
Console.WriteLine("Client connected.");
try
{
// Read user input and send that to the client process.
using (StreamWriter sw = new StreamWriter(pipeServer))
{
sw.AutoFlush = true;
Console.Write("Enter text: ");
sw.WriteLine(Console.ReadLine());
}
}
// Catch the IOException that is raised if the pipe is broken
// or disconnected.
catch (IOException e)
{
Console.WriteLine("ERROR: {0}", e.Message);
}
}
}
}
Imports System.IO
Imports System.IO.Pipes
Class PipeServer
Shared Sub Main()
Dim pipeServer As New NamedPipeServerStream("testpipe", PipeDirection.Out)
Console.WriteLine("NamedPipeServerStream object created.")
' Wait for a client to connect
Console.Write("Waiting for a client connection...")
pipeServer.WaitForConnection()
Console.WriteLine("Client connected.")
Try
'Read user input and send that to the client process.
Dim sw As New StreamWriter(pipeServer)
sw.AutoFlush = True
Console.Write("Enter Text: ")
sw.WriteLine(Console.ReadLine())
Catch ex As IOException
' Catch the IOException that is raised if the pipe is broken
' or disconnected
Console.WriteLine("ERROR: {0}", ex.Message)
End Try
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. Os pipes nomeados podem ser usados para comunicação entre processos localmente ou em 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.
No que diz respeito à segurança de thread para leitura e gravação, até um único leitor e um único gravador podem usar uma instância simultaneamente.
Construtores
| Nome | Description |
|---|---|
| NamedPipeServerStream(PipeDirection, Boolean, Boolean, SafePipeHandle) |
Inicializa uma nova instância da classe do NamedPipeServerStream identificador de pipe especificado. |
| NamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode, PipeOptions, Int32, Int32, PipeSecurity, HandleInheritability, PipeAccessRights) |
Inicializa uma nova instância da classe com o nome do NamedPipeServerStream pipe especificado, direção do pipe, número máximo de instâncias de servidor, modo de transmissão, opções de pipe, tamanhos de buffer de entrada e saída recomendados, segurança de pipe, modo de herdabilidade e direitos de acesso de pipe. |
| NamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode, PipeOptions, Int32, Int32, PipeSecurity, HandleInheritability) |
Inicializa uma nova instância da classe com o nome do NamedPipeServerStream pipe especificado, direção do pipe, número máximo de instâncias de servidor, modo de transmissão, opções de pipe, tamanhos de buffer de entrada e saída, segurança de pipe e modo de herdabilidade especificados. |
| NamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode, PipeOptions, Int32, Int32, PipeSecurity) |
Inicializa uma nova instância da classe com o nome do NamedPipeServerStream pipe especificado, direção do pipe, número máximo de instâncias de servidor, modo de transmissão, opções de pipe, tamanhos de buffer de entrada e saída recomendados e segurança de pipe. |
| NamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode, PipeOptions, Int32, Int32) |
Inicializa uma nova instância da classe com o nome do NamedPipeServerStream pipe, a direção do pipe, o número máximo de instâncias do servidor, o modo de transmissão, as opções de pipe e os tamanhos de buffer de entrada e saída recomendados. |
| NamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode, PipeOptions) |
Inicializa uma nova instância da classe com o nome do NamedPipeServerStream pipe, a direção do pipe, o número máximo de instâncias de servidor, o modo de transmissão e as opções de pipe especificados. |
| NamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode) |
Inicializa uma nova instância da NamedPipeServerStream classe com o nome do pipe, a direção do pipe, o número máximo de instâncias de servidor e o modo de transmissão especificados. |
| NamedPipeServerStream(String, PipeDirection, Int32) |
Inicializa uma nova instância da NamedPipeServerStream classe com o nome do pipe, a direção do pipe e o número máximo de instâncias de servidor especificados. |
| NamedPipeServerStream(String, PipeDirection) |
Inicializa uma nova instância da NamedPipeServerStream classe com o nome do pipe e a direção do pipe especificados. |
| NamedPipeServerStream(String) |
Inicializa uma nova instância da NamedPipeServerStream classe com o nome do pipe especificado. |
Campos
| Nome | Description |
|---|---|
| MaxAllowedServerInstances |
Representa o número máximo de instâncias de servidor que os recursos do sistema permitem. |
Propriedades
| Nome | Description |
|---|---|
| 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 busca. (Herdado de PipeStream) |
| CanTimeout |
Obtém um valor que determina se o fluxo atual pode acabar. (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 de um pipe. (Herdado de PipeStream) |
| IsAsync |
Obtém um valor que indica se um PipeStream objeto foi aberto de forma assíncrona ou síncrona. (Herdado de PipeStream) |
| IsConnected |
Obtém ou define um valor que indica se um PipeStream objeto está conectado. (Herdado de PipeStream) |
| IsHandleExposed |
Obtém um valor que indica se um identificador para um PipeStream objeto é 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) |
| OutBufferSize |
Obtém o tamanho, em bytes, do buffer de saída de 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 de um PipeStream objeto. (Herdado de PipeStream) |
| ReadTimeout |
Obtém ou define um valor, em milissegundos, que determina quanto tempo o fluxo tentará ler antes do tempo limite. (Herdado de Stream) |
| SafePipeHandle |
Obtém o identificador seguro para a extremidade local do pipe que o objeto atual PipeStream encapsula. (Herdado de PipeStream) |
| TransmissionMode |
Obtém o modo de transmissão de pipe com suporte pelo pipe atual. (Herdado de PipeStream) |
| WriteTimeout |
Obtém ou define um valor, em milissegundos, que determina por quanto tempo o fluxo tentará gravar antes do tempo limite. (Herdado de Stream) |
Métodos
| Nome | Description |
|---|---|
| BeginRead(Byte[], Int32, Int32, AsyncCallback, Object) |
Inicia uma operação de leitura assíncrona. (Herdado de PipeStream) |
| BeginWaitForConnection(AsyncCallback, Object) |
Inicia uma operação assíncrona para aguardar a conexão de um cliente. |
| BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object) |
Inicia uma operação de gravação assíncrona. (Herdado de PipeStream) |
| CheckPipePropertyOperations() |
Verifica se o pipe está em um estado adequado 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 arquivo) associados ao fluxo atual. Em vez de chamar esse método, verifique se o fluxo foi descartado corretamente. (Herdado de Stream) |
| CopyTo(Stream, Int32) |
Lê os bytes do fluxo atual e os grava em outro fluxo, usando um tamanho de buffer especificado. Ambas as posições de fluxos são avançadas pelo número de bytes copiados. (Herdado de Stream) |
| CopyTo(Stream) |
Lê os bytes do fluxo atual e os grava em outro fluxo. Ambas as posições de fluxos são avançadas pelo número de bytes copiados. (Herdado de Stream) |
| CopyToAsync(Stream, CancellationToken) |
Lê assíncronamente os bytes do fluxo atual e os grava em outro fluxo, usando um token de cancelamento especificado. Ambas as posições de fluxos são avançadas pelo número de bytes copiados. (Herdado de Stream) |
| CopyToAsync(Stream, Int32, CancellationToken) |
Lê assíncronamente os bytes do fluxo atual e os grava em outro fluxo, usando um token de cancelamento e tamanho de buffer especificado. Ambas as posições de fluxos são avançadas pelo número de bytes copiados. (Herdado de Stream) |
| CopyToAsync(Stream, Int32) |
Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo, usando um tamanho de buffer especificado. Ambas as posições de fluxos são avançadas pelo número de bytes copiados. (Herdado de Stream) |
| CopyToAsync(Stream) |
Lê assíncronamente os bytes do fluxo atual e os grava em outro fluxo. Ambas as posições de fluxos 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.
Obsoleto.
Obsoleto.
Aloca um objeto WaitHandle. (Herdado de Stream) |
| Disconnect() |
Desconecta a conexão atual. |
| Dispose() |
Libera todos os recursos usados pelo Stream. (Herdado de Stream) |
| Dispose(Boolean) |
Libera os recursos não gerenciados usados pela PipeStream classe 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) |
| EndWaitForConnection(IAsyncResult) |
Encerra uma operação assíncrona para aguardar a conexão de um cliente. |
| 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 NamedPipeServerStream instância seja recuperada pela coleta de lixo. |
| Flush() |
Limpa o buffer do fluxo atual e faz com que todos os dados em buffer sejam gravados no dispositivo subjacente. (Herdado de PipeStream) |
| FlushAsync() |
Limpa de forma assíncrona todos os buffers para esse fluxo e faz com que todos os dados em buffer sejam gravados no dispositivo subjacente. (Herdado de Stream) |
| FlushAsync(CancellationToken) |
Limpa de forma assíncrona o buffer do fluxo atual e faz com que todos os dados em buffer sejam gravados no dispositivo subjacente. (Herdado de PipeStream) |
| GetAccessControl() |
Obtém um PipeSecurity objeto que encapsula as entradas de ACL (lista de controle de acesso) para o pipe descrito pelo objeto atual PipeStream . (Herdado de PipeStream) |
| GetHashCode() |
Serve como a função de hash padrão. (Herdado de Object) |
| GetImpersonationUserName() |
Obtém o nome de usuário do cliente na outra extremidade do pipe. |
| GetLifetimeService() |
Obsoleto.
Recupera o objeto de serviço de tempo de vida atual que controla a política de tempo de vida para essa instância. (Herdado de MarshalByRefObject) |
| GetType() |
Obtém o Type da instância atual. (Herdado de Object) |
| InitializeHandle(SafePipeHandle, Boolean, Boolean) |
Inicializa um PipeStream objeto do objeto especificado SafePipeHandle . (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 dessa instância. (Herdado de MarshalByRefObject) |
| MemberwiseClone() |
Cria uma cópia superficial do Objectatual. (Herdado de Object) |
| MemberwiseClone(Boolean) |
Cria uma cópia superficial do objeto atual MarshalByRefObject . (Herdado de MarshalByRefObject) |
| ObjectInvariant() |
Obsoleto.
Fornece suporte para 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 comprimento especificado. (Herdado de PipeStream) |
| Read(Span<Byte>) |
Lê uma sequência de bytes do fluxo atual, grava-os em uma matriz de bytes e avança a posição dentro do fluxo pelo número de bytes lidos. (Herdado de PipeStream) |
| ReadAsync(Byte[], Int32, Int32, CancellationToken) |
Lê de forma assíncrona uma sequência de bytes do fluxo atual para uma matriz de bytes começando em uma posição especificada para um número especificado de bytes, avança a posição dentro do fluxo pelo número de bytes lidos e monitora solicitações de cancelamento. (Herdado de PipeStream) |
| ReadAsync(Byte[], Int32, Int32) |
Lê de forma assíncrona uma sequência de bytes do fluxo atual e avança a posição dentro do fluxo pelo número de bytes lidos. (Herdado de Stream) |
| ReadAsync(Memory<Byte>, CancellationToken) |
Lê de forma assíncrona uma sequência de bytes do fluxo atual, grava-os em um intervalo de memória de bytes, avança a posição dentro do fluxo pelo número de bytes lidos e monitora 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ê |
| ReadExactly(Span<Byte>) |
Lê bytes do fluxo atual e avança a posição dentro do fluxo até que ela |
| ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken) |
Lê |
| ReadExactlyAsync(Memory<Byte>, CancellationToken) |
Lê bytes de forma assíncrona do fluxo atual, avança a posição dentro do fluxo até que ele |
| RunAsClient(PipeStreamImpersonationWorker) |
Chama um delegado ao representar o cliente. |
| Seek(Int64, SeekOrigin) |
Define a posição atual do fluxo atual como o valor especificado. (Herdado de PipeStream) |
| SetAccessControl(PipeSecurity) |
Aplica as entradas de ACL (lista de controle de acesso) especificadas por um PipeSecurity objeto ao pipe especificado pelo objeto atual PipeStream . (Herdado de PipeStream) |
| SetLength(Int64) |
Define o comprimento do fluxo atual como o valor especificado. (Herdado de PipeStream) |
| ToString() |
Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object) |
| WaitForConnection() |
Aguarda que um cliente se conecte a esse NamedPipeServerStream objeto. |
| WaitForConnectionAsync() |
Espera de forma assíncrona que um cliente se conecte a esse NamedPipeServerStream objeto. |
| WaitForConnectionAsync(CancellationToken) |
Espera de forma assíncrona que um cliente se conecte a esse NamedPipeServerStream objeto e monitora solicitações de cancelamento. |
| WaitForPipeDrain() |
Aguarda a outra extremidade do pipe ler todos os bytes enviados. (Herdado de PipeStream) |
| Write(Byte[], Int32, Int32) |
Grava um bloco de bytes no fluxo atual usando 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, 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 dentro desse fluxo pelo número de bytes gravados e monitora solicitações de cancelamento. (Herdado de PipeStream) |
| WriteAsync(Byte[], Int32, Int32) |
Grava de forma assíncrona 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 Stream) |
| WriteAsync(ReadOnlyMemory<Byte>, CancellationToken) |
Grava de forma assíncrona uma sequência de bytes no fluxo atual, avança a posição atual dentro desse fluxo pelo número de bytes gravados e monitora solicitações de cancelamento. (Herdado de PipeStream) |
| WriteByte(Byte) |
Grava um byte no fluxo atual. (Herdado de PipeStream) |
Métodos de Extensão
| Nome | Description |
|---|---|
| ConfigureAwait(IAsyncDisposable, Boolean) |
Configura como as esperas nas tarefas retornadas de um descartável assíncrono serão executadas. |
| CopyToAsync(Stream, PipeWriter, CancellationToken) |
Lê de forma assíncrona os bytes e Stream os grava no especificado PipeWriter, usando um token de cancelamento. |
| 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. |
