NamedPipeClientStream Clase

  • Referencia

Definición

Espacio de nombres:
System.IO.Pipes
Ensamblado:
System.IO.Pipes.dll
Ensamblado:
System.Core.dll
Ensamblado:
netstandard.dll
Source:
NamedPipeClientStream.cs
Source:
NamedPipeClientStream.cs
Source:
NamedPipeClientStream.cs

Expone un Stream alrededor de una canalización con nombre, que admite operaciones de lectura y escritura sincrónica y asincrónica.

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
Herencia
Object
Stream
PipeStream
NamedPipeClientStream
Herencia
Object
MarshalByRefObject
Stream
PipeStream
NamedPipeClientStream

Ejemplos

En el ejemplo siguiente se muestra una manera de enviar una cadena de un proceso primario a un proceso secundario en el mismo equipo mediante canalizaciones con nombre. En este ejemplo se crea un NamedPipeServerStream objeto en un proceso primario. El NamedPipeServerStream objeto tiene un PipeDirection valor de Out. A continuación, el servidor espera a que un NamedPipeClientStream objeto de un proceso secundario se conecte a él. En este ejemplo, ambos procesos están en el mismo equipo y el NamedPipeClientStream objeto tiene un PipeDirection valor de In. El proceso primario envía a continuación una cadena proporcionada por usuario al proceso secundario. La cadena se muestra en la consola.

Este ejemplo es para el proceso de cliente, que se conecta al proceso de servidor. Para obtener todo el ejemplo de código, incluido el código para el cliente de canalización y el servidor, vea Cómo: Usar canalizaciones con nombre para la comunicación entre procesos de red.

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

Comentarios

Las canalizaciones con nombre proporcionan canalizaciones unidireccionales o dúplex para la comunicación entre un servidor de canalización y uno o varios clientes de canalización. Las canalizaciones con nombre se pueden usar para la comunicación entre procesos localmente o a través de una red. Varios objetos pueden compartir NamedPipeClientStream un único nombre de canalización.

Cualquier proceso puede actuar como un cliente o un servidor de canalización con nombre, o ambos.

Constructores

NamedPipeClientStream(PipeDirection, Boolean, Boolean, SafePipeHandle)

Inicializa una nueva instancia de la clase NamedPipeClientStream para el identificador de canalización especificado con la dirección de canalización especificada.
NamedPipeClientStream(String)

Inicializa una nueva instancia de la clase NamedPipeClientStream con el nombre de canalización especificado.
NamedPipeClientStream(String, String)

Inicializa una nueva instancia de la clase NamedPipeClientStream con los nombres de canalización y servidor especificados.
NamedPipeClientStream(String, String, PipeAccessRights, PipeOptions, TokenImpersonationLevel, HandleInheritability)

Inicializa una nueva instancia de la clase NamedPipeClientStream con los nombres de canalización y servidor especificados, y las características opciones de canalización, nivel de suplantación de seguridad y modo de herencia especificadas.
NamedPipeClientStream(String, String, PipeDirection)

Inicializa una nueva instancia de la clase NamedPipeClientStream con los nombres de canalización y servidor especificados y la dirección de canalización especificada.
NamedPipeClientStream(String, String, PipeDirection, PipeOptions)

Inicializa una nueva instancia de la clase NamedPipeClientStream con los nombres de canalización y servidor especificados, y la dirección y opciones de canalización especificadas.
NamedPipeClientStream(String, String, PipeDirection, PipeOptions, TokenImpersonationLevel)

Inicializa una nueva instancia de la clase NamedPipeClientStream con los nombres de canalización y servidor especificados, y las características dirección de canalización, opciones de canalización y nivel de suplantación de seguridad especificadas.
NamedPipeClientStream(String, String, PipeDirection, PipeOptions, TokenImpersonationLevel, HandleInheritability)

Inicializa una nueva instancia de la clase NamedPipeClientStream con los nombres de canalización y servidor especificados, y las características dirección de canalización, opciones de canalización, nivel de suplantación de seguridad y modo de herencia especificadas.

Propiedades

CanRead

Obtiene un valor que indica si la secuencia actual admite operaciones de lectura.

(Heredado de PipeStream)
CanSeek

Obtiene un valor que indica si la secuencia actual admite operaciones de búsqueda.

(Heredado de PipeStream)
CanTimeout

Obtiene un valor que determina si se puede agotar el tiempo de espera de la secuencia actual.

(Heredado de Stream)
CanWrite

Obtiene un valor que indica si la secuencia actual admite operaciones de escritura.

(Heredado de PipeStream)
InBufferSize

Obtiene el tamaño en bytes del búfer de entrada de una canalización.

(Heredado de PipeStream)
IsAsync

Obtiene un valor que indica si un objeto PipeStream se abrió de forma sincrónica o asincrónica.

(Heredado de PipeStream)
IsConnected

Obtiene o establece un valor que indica si un objeto PipeStream está conectado.

(Heredado de PipeStream)
IsHandleExposed

Obtiene un valor que indica si se expone un identificador a un objeto PipeStream.

(Heredado de PipeStream)
IsMessageComplete

Obtiene un valor que indica si hay más datos en el mensaje devuelto desde la operación de lectura más reciente.

(Heredado de PipeStream)
Length

Devuelve la longitud en bytes de una secuencia.

(Heredado de PipeStream)
NumberOfServerInstances

Obtiene el número máximo de instancias de servidor que comparten el mismo nombre de canalización.
OutBufferSize

Obtiene el tamaño en bytes del búfer de salida de una canalización.

(Heredado de PipeStream)
Position

Obtiene o establece la posición de la secuencia actual.

(Heredado de PipeStream)
ReadMode

Obtiene o establece el modo de lectura de un objeto PipeStream.

(Heredado de PipeStream)
ReadTimeout

Obtiene o establece un valor, en milisegundos, que determina durante cuánto tiempo la secuencia intentará realizar operaciones de lectura antes de que se agote el tiempo de espera.

(Heredado de Stream)
SafePipeHandle

Obtiene el identificador seguro del extremo local de la canalización encapsulada por el objeto PipeStream actual.

(Heredado de PipeStream)
TransmissionMode

Obtiene el modo de transmisión de canalización compatible con la canalización actual.

(Heredado de PipeStream)
WriteTimeout

Obtiene o establece un valor, en milisegundos, que determina durante cuánto tiempo la secuencia intentará realizar operaciones de escritura antes de que se agote el tiempo de espera.

(Heredado de Stream)

Métodos

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

Comienza una operación de lectura asincrónica.

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

Comienza una operación de escritura asincrónica.

(Heredado de PipeStream)
CheckPipePropertyOperations()

Comprueba si la canalización está en el estado apropiado para obtener o establecer las propiedades.

(Heredado de PipeStream)
CheckReadOperations()

Comprueba si la canalización está en estado conectado para las operaciones de lectura.

(Heredado de PipeStream)
CheckWriteOperations()

Comprueba si la canalización está en estado conectado para las operaciones de escritura.

(Heredado de PipeStream)
Close()

Cierra la secuencia actual y libera todos los recursos (como sockets e identificadores de archivo) asociados a esta. En lugar de llamar a este método, asegúrese de que la secuencia se desecha correctamente.

(Heredado de Stream)
Connect()

Conecta a un servidor de espera con un valor de tiempo de espera infinito.
Connect(Int32)

Conecta con un servidor de espera dentro del período de tiempo de espera especificado.
Connect(TimeSpan)

Se conecta a un servidor en espera dentro del período de tiempo de espera especificado.
ConnectAsync()

Se conecta de manera asincrónica a un servidor en espera con un período de tiempo de espera infinito.
ConnectAsync(CancellationToken)

Se conecta de manera asincrónica a un servidor en espera y supervisa las solicitudes de cancelación.
ConnectAsync(Int32)

Se conecta de manera asincrónica a un servidor en espera dentro del período de tiempo de espera especificado.
ConnectAsync(Int32, CancellationToken)

Se conecta de manera asincrónica a un servidor en espera dentro del período de tiempo de espera especificado y supervisa las solicitudes de cancelación.
ConnectAsync(TimeSpan, CancellationToken)

Se conecta de manera asincrónica a un servidor en espera dentro del período de tiempo de espera especificado y supervisa las solicitudes de cancelación.
CopyTo(Stream)

Lee los bytes de la secuencia actual y los escribe en otra secuencia de destino. Ambas posiciones de secuencias están avanzadas por el número de bytes copiados.

(Heredado de Stream)
CopyTo(Stream, Int32)

Lee todos los bytes de la secuencia actual y los escribe en otra secuencia, usando el tamaño de búfer especificado. Ambas posiciones de secuencias están avanzadas por el número de bytes copiados.

(Heredado de Stream)
CopyToAsync(Stream)

Lee asincrónicamente los bytes de la secuencia actual y los escribe en otra secuencia. Ambas posiciones de secuencias están avanzadas por el número de bytes copiados.

(Heredado de Stream)
CopyToAsync(Stream, CancellationToken)

Lee de forma asincrónica los bytes de la secuencia actual y los escribe en otra secuencia mediante un token de cancelación especificado. Ambas posiciones de secuencias están avanzadas por el número de bytes copiados.

(Heredado de Stream)
CopyToAsync(Stream, Int32)

Lee asincrónicamente los bytes de la secuencia actual y los escribe en otra secuencia, usando el tamaño de búfer especificado. Ambas posiciones de secuencias están avanzadas por el número de bytes copiados.

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

Lee asincrónicamente los bytes de la secuencia actual y los escribe en otra secuencia, utilizando el tamaño de búfer y el token de cancelación especificados. Ambas posiciones de secuencias están avanzadas por el número de bytes copiados.

(Heredado de Stream)
CreateObjRef(Type)

Crea un objeto que contiene toda la información relevante necesaria para generar un proxy utilizado para comunicarse con un objeto remoto.

(Heredado de MarshalByRefObject)
CreateWaitHandle()
Obsoletos.
Obsoletos.
Obsoletos.

Asigna un objeto WaitHandle.

(Heredado de Stream)
Dispose()

Libera todos los recursos que usa Stream.

(Heredado de Stream)
Dispose(Boolean)

Libera los recursos no administrados utilizados por la clase PipeStream y, de forma opcional, libera los recursos administrados.

(Heredado de PipeStream)
DisposeAsync()

Libera de forma asincrónica los recursos no administrados usados por Stream.

(Heredado de Stream)
EndRead(IAsyncResult)

Finaliza una solicitud de lectura asincrónica pendiente.

(Heredado de PipeStream)
EndWrite(IAsyncResult)

Finaliza una solicitud de escritura asincrónica pendiente.

(Heredado de PipeStream)
Equals(Object)

Determina si el objeto especificado es igual que el objeto actual.

(Heredado de Object)
Finalize()

Libera recursos no administrados y realiza otras operaciones de limpieza antes de que la recolección de elementos no utilizados reclame la instancia de NamedPipeClientStream.
Flush()

Borra el búfer de la secuencia actual y hace que todos los datos almacenados en el búfer se escriban en el dispositivo subyacente.

(Heredado de PipeStream)
FlushAsync()

Borra asincrónicamente todos los búferes de esta secuencia y hace que los datos almacenados en búfer se escriban en el dispositivo subyacente.

(Heredado de Stream)
FlushAsync(CancellationToken)

Borra el búfer de la secuencia actual de manera asincrónica y hace que todos los datos almacenados en el búfer se escriban en el dispositivo subyacente.

(Heredado de PipeStream)
GetAccessControl()

Obtiene un objeto PipeSecurity que encapsula las entradas de la lista de control de acceso (ACL) de la canalización descrita por el objeto PipeStream actual.

(Heredado de PipeStream)
GetHashCode()

Sirve como la función hash predeterminada.

(Heredado de Object)
GetLifetimeService()
Obsoletos.

Recupera el objeto de servicio de duración actual que controla la directiva de duración de esta instancia.

(Heredado de MarshalByRefObject)
GetType()

Obtiene el Type de la instancia actual.

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

Inicializa un objeto PipeStream a partir del objeto SafePipeHandle especificado.

(Heredado de PipeStream)
InitializeLifetimeService()
Obsoletos.

Obtiene un objeto de servicio de duración para controlar la directiva de duración de esta instancia.

(Heredado de MarshalByRefObject)
MemberwiseClone()

Crea una copia superficial del Object actual.

(Heredado de Object)
MemberwiseClone(Boolean)

Crea una copia superficial del objeto MarshalByRefObject actual.

(Heredado de MarshalByRefObject)
ObjectInvariant()
Obsoletos.

Proporciona compatibilidad con una clase Contract.

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

Lee un bloque de bytes de una secuencia y escribe los datos en un búfer especificado, a partir de una posición especificada y con una longitud especificada.

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

Lee una secuencia de bytes de la secuencia actual, las escribe en una matriz de bytes y avanza la posición dentro de la secuencia el número de bytes leídos.

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

Lee asincrónicamente una secuencia de bytes de la secuencia actual y avanza la posición en esta secuencia según el número de bytes leídos.

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

Lee de forma asincrónica una secuencia de bytes desde la secuencia actual a una matriz de bytes a partir de una posición especificada para un número de bytes especificado, avanza la posición dentro de la secuencia el número de bytes leídos y supervisa las solicitudes de cancelación.

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

Lee de forma asincrónica una secuencia de bytes en la secuencia actual, los escribe en un intervalo de memoria de bytes, avanza la posición dentro de la secuencia el número de bytes leídos y supervisa las solicitudes de cancelación.

(Heredado de PipeStream)
ReadAtLeast(Span<Byte>, Int32, Boolean)

Lee al menos un número mínimo de bytes de la secuencia actual y avanza la posición dentro de la secuencia por el número de bytes leídos.

(Heredado de Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)

Lee de forma asincrónica al menos un número mínimo de bytes de la secuencia actual, avanza la posición dentro de la secuencia por el número de bytes leídos y supervisa las solicitudes de cancelación.

(Heredado de Stream)
ReadByte()

Lee un byte de una canalización.

(Heredado de PipeStream)
ReadExactly(Byte[], Int32, Int32)

count Lee el número de bytes de la secuencia actual y avanza la posición dentro de la secuencia.

(Heredado de Stream)
ReadExactly(Span<Byte>)

Lee bytes de la secuencia actual y avanza la posición dentro de la secuencia hasta buffer que se rellena .

(Heredado de Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)

Lee count de forma asincrónica el número de bytes de la secuencia actual, avanza la posición dentro de la secuencia y supervisa las solicitudes de cancelación.

(Heredado de Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)

Lee de forma asincrónica los bytes de la secuencia actual, avanza la posición dentro de la secuencia hasta buffer que se rellena y supervisa las solicitudes de cancelación.

(Heredado de Stream)
Seek(Int64, SeekOrigin)

Establece la posición actual de esta secuencia en el valor especificado.

(Heredado de PipeStream)
SetAccessControl(PipeSecurity)

Aplica las entradas de la lista de control de acceso (ACL) especificadas por un objeto PipeSecurity a la canalización establecida por el objeto PipeStream actual.

(Heredado de PipeStream)
SetLength(Int64)

Establece la longitud de la secuencia actual en el valor especificado.

(Heredado de PipeStream)
ToString()

Devuelve una cadena que representa el objeto actual.

(Heredado de Object)
WaitForPipeDrain()

Espera hasta que el otro final de la canalización lea todos los bytes enviados.

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

Escribe un bloque de bytes en la secuencia actual utilizando los datos de un búfer.

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

Escribe una secuencia de bytes en la secuencia actual y avanza la posición actual en esta secuencia según el número de bytes escritos.

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

Escribe asincrónicamente una secuencia de bytes en la secuencia actual y avanza la posición actual en esta secuencia según el número de bytes escritos.

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

Escribe de forma asincrónica un número especificado de bytes en una matriz de bytes a partir de una posición especificada, avanza la posición actual dentro de esta secuencia el número de bytes escritos y supervisa las solicitudes de cancelación.

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

Escribe de forma asincrónica una secuencia de bytes en la secuencia actual, se hace avanzar la posición actual dentro de la secuencia el número de bytes escritos y controla las solicitudes de cancelación.

(Heredado de PipeStream)
WriteByte(Byte)

Escribe un byte en la secuencia actual.

(Heredado de PipeStream)

Métodos de extensión

GetAccessControl(PipeStream)

Devuelve la información de seguridad de un flujo de canalización.
SetAccessControl(PipeStream, PipeSecurity)

Cambia los atributos de seguridad de un flujo de canalización existente.
ConfigureAwait(IAsyncDisposable, Boolean)

Configura la forma en la que se realizan las expresiones await en las tareas devueltas desde un elemento asincrónico descartable.

Se aplica a