Partage via


AnonymousPipeClientStream Classe

Définition

Expose le côté client d’un flux de canal anonyme, qui prend en charge les opérations de lecture et d’écriture synchrones et asynchrones (sans prise en charge de l’annulation sur les plateformes Windows).

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
Héritage
AnonymousPipeClientStream
Héritage
AnonymousPipeClientStream

Exemples

L’exemple suivant envoie une chaîne d’un processus parent à un processus enfant à l’aide de canaux anonymes. Cet exemple crée un objet AnonymousPipeServerStream dans un processus parent avec une valeur PipeDirection de Out. Il crée également un objet AnonymousPipeClientStream dans un processus enfant avec une valeur PipeDirection de In. Le processus parent envoie ensuite une chaîne fournie par l’utilisateur au processus enfant. La chaîne s’affiche dans la console.

Cet exemple concerne le processus client, qui est démarré par le processus serveur. Nommez l’exécutable résultant du code client pipeClient.exe et copiez-le dans le même répertoire que l’exécutable du serveur lorsque vous exécutez cet exemple. Pour l’exemple de code entier, y compris le code du client de canal et du serveur, consultez Guide pratique pour utiliser des canaux anonymes pour la communication interprocesseur locale.

//<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>

Remarques

Les canaux anonymes permettent de fournir une communication interprocesseur sécurisée et sécurisée entre les processus enfants et parents. La classe AnonymousPipeClientStream permet à un processus enfant de se connecter et d’échanger des informations avec un processus parent.

Les canaux anonymes sont des canaux non nommés et unidirectionnel qui transfèrent généralement des données entre les processus parent et enfant. Les canaux anonymes sont toujours locaux ; ils ne peuvent pas être utilisés sur un réseau. Une valeur PipeDirection de InOut n’est pas prise en charge, car les canaux anonymes sont définis de manière unidirectionnel.

Les canaux anonymes ne prennent pas en charge le mode de lecture PipeTransmissionMode.Message.

Le côté client d’un canal anonyme doit être créé à partir d’un handle de canal fourni par le serveur en appelant la méthode GetClientHandleAsString. La chaîne est ensuite passée en tant que paramètre lors de la création du processus client. À partir du processus client, il est passé au constructeur AnonymousPipeClientStream en tant que paramètre pipeHandleAsString.

Sur Windows, les opérations de lecture et d’écriture asynchrones (superposées) ne sont pas prises en charge par les canaux anonymes (voir opérations de canal anonyme). La classe AnonymousPipeClientStream planifie toujours le travail sur le pool de threads sur les plateformes Windows afin que les opérations asynchrones Stream fonctionnent, mais l’annulation de ces opérations n’est pas prise en charge.

Constructeurs

AnonymousPipeClientStream(PipeDirection, SafePipeHandle)

Initialise une nouvelle instance de la classe AnonymousPipeClientStream à partir du handle spécifié.

AnonymousPipeClientStream(PipeDirection, String)

Initialise une nouvelle instance de la classe AnonymousPipeClientStream avec le sens du canal spécifié et une représentation sous forme de chaîne du handle de canal.

AnonymousPipeClientStream(String)

Initialise une nouvelle instance de la classe AnonymousPipeClientStream avec la représentation sous forme de chaîne spécifiée du handle de canal.

Propriétés

CanRead

Obtient une valeur indiquant si le flux actuel prend en charge les opérations de lecture.

(Hérité de PipeStream)
CanSeek

Obtient une valeur indiquant si le flux actuel prend en charge les opérations de recherche.

(Hérité de PipeStream)
CanTimeout

Obtient une valeur qui détermine si le flux actuel peut expirer.

(Hérité de Stream)
CanWrite

Obtient une valeur indiquant si le flux actuel prend en charge les opérations d’écriture.

(Hérité de PipeStream)
InBufferSize

Obtient la taille, en octets, de la mémoire tampon entrante pour un canal.

(Hérité de PipeStream)
IsAsync

Obtient une valeur indiquant si un objet PipeStream a été ouvert de manière asynchrone ou synchrone.

(Hérité de PipeStream)
IsConnected

Obtient ou définit une valeur indiquant si un objet PipeStream est connecté.

(Hérité de PipeStream)
IsHandleExposed

Obtient une valeur indiquant si un handle vers un objet PipeStream est exposé.

(Hérité de PipeStream)
IsMessageComplete

Obtient une valeur indiquant s’il existe plus de données dans le message retourné par l’opération de lecture la plus récente.

(Hérité de PipeStream)
Length

Obtient la longueur d’un flux, en octets.

(Hérité de PipeStream)
OutBufferSize

Obtient la taille, en octets, de la mémoire tampon sortante d’un canal.

(Hérité de PipeStream)
Position

Obtient ou définit la position actuelle du flux actuel.

(Hérité de PipeStream)
ReadMode

Définit le mode de lecture de l’objet AnonymousPipeClientStream.

ReadTimeout

Obtient ou définit une valeur, en millisecondes, qui détermine la durée pendant laquelle le flux tente de lire avant l’expiration du délai d’attente.

(Hérité de Stream)
SafePipeHandle

Obtient le handle sécurisé pour la fin locale du canal que l’objet PipeStream actuel encapsule.

(Hérité de PipeStream)
TransmissionMode

Obtient le mode de transmission de canal pris en charge par le canal actuel.

WriteTimeout

Obtient ou définit une valeur, en millisecondes, qui détermine la durée pendant laquelle le flux tentera d’écrire avant l’expiration du délai d’attente.

(Hérité de Stream)

Méthodes

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

Commence une opération de lecture asynchrone.

(Hérité de PipeStream)
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)

Commence une opération d’écriture asynchrone.

(Hérité de PipeStream)
CheckPipePropertyOperations()

Vérifie que le canal est dans un état approprié pour obtenir ou définir des propriétés.

(Hérité de PipeStream)
CheckReadOperations()

Vérifie que le canal est dans un état connecté pour les opérations de lecture.

(Hérité de PipeStream)
CheckWriteOperations()

Vérifie que le canal est dans un état connecté pour les opérations d’écriture.

(Hérité de PipeStream)
Close()

Ferme le flux actuel et libère toutes les ressources (telles que les sockets et les handles de fichiers) associées au flux actuel. Au lieu d’appeler cette méthode, vérifiez que le flux est correctement supprimé.

(Hérité de Stream)
CopyTo(Stream)

Lit les octets du flux actuel et les écrit dans un autre flux. Les deux positions de flux sont avancées par le nombre d’octets copiés.

(Hérité de Stream)
CopyTo(Stream, Int32)

Lit les octets du flux actuel et les écrit dans un autre flux à l’aide d’une taille de mémoire tampon spécifiée. Les deux positions de flux sont avancées par le nombre d’octets copiés.

(Hérité de Stream)
CopyToAsync(Stream)

Lit de manière asynchrone les octets du flux actuel et les écrit dans un autre flux. Les deux positions de flux sont avancées par le nombre d’octets copiés.

(Hérité de Stream)
CopyToAsync(Stream, CancellationToken)

Lit de manière asynchrone les octets du flux actuel et les écrit dans un autre flux à l’aide d’un jeton d’annulation spécifié. Les deux positions de flux sont avancées par le nombre d’octets copiés.

(Hérité de Stream)
CopyToAsync(Stream, Int32)

Lit de façon asynchrone les octets du flux actuel et les écrit dans un autre flux à l’aide d’une taille de mémoire tampon spécifiée. Les deux positions de flux sont avancées par le nombre d’octets copiés.

(Hérité de Stream)
CopyToAsync(Stream, Int32, CancellationToken)

Lit de manière asynchrone les octets du flux actuel et les écrit dans un autre flux à l’aide d’une taille de mémoire tampon et d’un jeton d’annulation spécifiés. Les deux positions de flux sont avancées par le nombre d’octets copiés.

(Hérité de Stream)
CreateObjRef(Type)

Crée un objet qui contient toutes les informations pertinentes requises pour générer un proxy utilisé pour communiquer avec un objet distant.

(Hérité de MarshalByRefObject)
CreateWaitHandle()
Obsolète.
Obsolète.
Obsolète.

Alloue un objet WaitHandle.

(Hérité de Stream)
Dispose()

Libère toutes les ressources utilisées par le Stream.

(Hérité de Stream)
Dispose(Boolean)

Libère les ressources non managées utilisées par la classe PipeStream et libère éventuellement les ressources managées.

(Hérité de PipeStream)
DisposeAsync()

Libère de façon asynchrone les ressources non managées utilisées par le Stream.

(Hérité de Stream)
EndRead(IAsyncResult)

Termine une demande de lecture asynchrone en attente.

(Hérité de PipeStream)
EndWrite(IAsyncResult)

Termine une demande d’écriture asynchrone en attente.

(Hérité de PipeStream)
Equals(Object)

Détermine si l’objet spécifié est égal à l’objet actuel.

(Hérité de Object)
Finalize()

Libère des ressources non managées et effectue d’autres opérations de nettoyage avant que l’instance de AnonymousPipeClientStream soit récupérée par le garbage collection.

Flush()

Efface la mémoire tampon du flux actuel et entraîne l’écriture de toutes les données mises en mémoire tampon sur l’appareil sous-jacent.

(Hérité de PipeStream)
FlushAsync()

Efface de façon asynchrone toutes les mémoires tampons de ce flux et entraîne l’écriture de toutes les données mises en mémoire tampon sur l’appareil sous-jacent.

(Hérité de Stream)
FlushAsync(CancellationToken)

Efface de façon asynchrone la mémoire tampon du flux actuel et entraîne l’écriture de toutes les données mises en mémoire tampon sur l’appareil sous-jacent.

(Hérité de PipeStream)
GetAccessControl()

Obtient un objet PipeSecurity qui encapsule les entrées de liste de contrôle d’accès (ACL) pour le canal décrit par l’objet PipeStream actuel.

(Hérité de PipeStream)
GetHashCode()

Sert de fonction de hachage par défaut.

(Hérité de Object)
GetLifetimeService()
Obsolète.

Récupère l’objet de service de durée de vie actuel qui contrôle la stratégie de durée de vie de cette instance.

(Hérité de MarshalByRefObject)
GetType()

Obtient la Type de l’instance actuelle.

(Hérité de Object)
InitializeHandle(SafePipeHandle, Boolean, Boolean)

Initialise un objet PipeStream à partir de l’objet SafePipeHandle spécifié.

(Hérité de PipeStream)
InitializeLifetimeService()
Obsolète.

Obtient un objet de service de durée de vie pour contrôler la stratégie de durée de vie de cette instance.

(Hérité de MarshalByRefObject)
MemberwiseClone()

Crée une copie superficielle du Objectactuel.

(Hérité de Object)
MemberwiseClone(Boolean)

Crée une copie superficielle de l’objet MarshalByRefObject actuel.

(Hérité de MarshalByRefObject)
ObjectInvariant()
Obsolète.

Fournit la prise en charge d’un Contract.

(Hérité de Stream)
Read(Byte[], Int32, Int32)

Lit un bloc d’octets d’un flux et écrit les données dans une mémoire tampon spécifiée à partir d’une position spécifiée pour une longueur spécifiée.

(Hérité de PipeStream)
Read(Span<Byte>)

Lit une séquence d’octets du flux actuel, les écrit dans un tableau d’octets et avance la position dans le flux par le nombre d’octets lus.

(Hérité de PipeStream)
ReadAsync(Byte[], Int32, Int32)

Lit de façon asynchrone une séquence d’octets à partir du flux actuel et avance la position dans le flux en fonction du nombre d’octets lus.

(Hérité de Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)

Lit de façon asynchrone une séquence d’octets du flux actuel vers un tableau d’octets à partir d’une position spécifiée pour un nombre spécifié d’octets, avance la position dans le flux par le nombre d’octets lus et surveille les demandes d’annulation.

(Hérité de PipeStream)
ReadAsync(Memory<Byte>, CancellationToken)

Lit de façon asynchrone une séquence d’octets du flux actuel, les écrit dans une plage de mémoire d’octets, avance la position dans le flux par le nombre d’octets lus et surveille les demandes d’annulation.

(Hérité de PipeStream)
ReadAtLeast(Span<Byte>, Int32, Boolean)

Lit au moins un nombre minimal d’octets du flux actuel et avance la position dans le flux par le nombre d’octets lus.

(Hérité de Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)

Lit de façon asynchrone au moins un nombre minimal d’octets à partir du flux actuel, avance la position dans le flux par le nombre d’octets lus et surveille les demandes d’annulation.

(Hérité de Stream)
ReadByte()

Lit un octet à partir d’un canal.

(Hérité de PipeStream)
ReadExactly(Byte[], Int32, Int32)

Lit count nombre d’octets du flux actuel et avance la position dans le flux.

(Hérité de Stream)
ReadExactly(Span<Byte>)

Lit les octets du flux actuel et avance la position dans le flux jusqu’à ce que le buffer soit rempli.

(Hérité de Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)

Lit de façon asynchrone count nombre d’octets du flux actuel, avance la position dans le flux et surveille les demandes d’annulation.

(Hérité de Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)

Lit de manière asynchrone les octets du flux actuel, avance la position dans le flux jusqu’à ce que le buffer soit rempli et surveille les demandes d’annulation.

(Hérité de Stream)
Seek(Int64, SeekOrigin)

Définit la position actuelle du flux actuel sur la valeur spécifiée.

(Hérité de PipeStream)
SetAccessControl(PipeSecurity)

Applique les entrées de liste de contrôle d’accès spécifiées par un objet PipeSecurity au canal spécifié par l’objet PipeStream actuel.

(Hérité de PipeStream)
SetLength(Int64)

Définit la longueur du flux actuel sur la valeur spécifiée.

(Hérité de PipeStream)
ToString()

Retourne une chaîne qui représente l’objet actuel.

(Hérité de Object)
WaitForPipeDrain()

Attend que l’autre extrémité du canal lit tous les octets envoyés.

(Hérité de PipeStream)
Write(Byte[], Int32, Int32)

Écrit un bloc d’octets dans le flux actuel à l’aide de données d’une mémoire tampon.

(Hérité de PipeStream)
Write(ReadOnlySpan<Byte>)

Écrit une séquence d’octets dans le flux actuel et avance la position actuelle dans ce flux par le nombre d’octets écrits.

(Hérité de PipeStream)
WriteAsync(Byte[], Int32, Int32)

Écrit de façon asynchrone une séquence d’octets dans le flux actuel et avance la position actuelle dans ce flux par le nombre d’octets écrits.

(Hérité de Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)

Écrit de façon asynchrone un nombre spécifié d’octets à partir d’un tableau d’octets à partir d’une position spécifiée, avance la position actuelle dans ce flux par le nombre d’octets écrits et surveille les demandes d’annulation.

(Hérité de PipeStream)
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Écrit de façon asynchrone une séquence d’octets dans le flux actuel, avance la position actuelle dans ce flux par le nombre d’octets écrits et surveille les demandes d’annulation.

(Hérité de PipeStream)
WriteByte(Byte)

Écrit un octet dans le flux actuel.

(Hérité de PipeStream)

Méthodes d’extension

CopyToAsync(Stream, PipeWriter, CancellationToken)

Lit de manière asynchrone les octets de l'Stream et les écrit dans le PipeWriterspécifié, à l’aide d’un jeton d’annulation.

GetAccessControl(PipeStream)

Retourne les informations de sécurité d’un flux de canal.

SetAccessControl(PipeStream, PipeSecurity)

Modifie les attributs de sécurité d’un flux de canal existant.

ConfigureAwait(IAsyncDisposable, Boolean)

Configure la façon dont les attentes sur les tâches retournées à partir d’un jetable asynchrone sont effectuées.

S’applique à