NamedPipeClientStream Klasse

Referenz

Definition

Namespace:: System.IO.Pipes

Assembly:: System.IO.Pipes.dll

Assembly:: System.Core.dll

Assembly:: netstandard.dll

Quelle:: NamedPipeClientStream.cs

Quelle:: NamedPipeClientStream.cs

Quelle:: NamedPipeClientStream.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Macht einen Stream um eine benannte Pipe verfügbar, der synchrone und asynchrone Lese- und Schreibvorgänge unterstützt.

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

Vererbung: Object

Stream

PipeStream
NamedPipeClientStream

Vererbung: Object

MarshalByRefObject

Stream

PipeStream
NamedPipeClientStream

Beispiele

Das folgende Beispiel veranschaulicht eine Möglichkeit zum Senden einer Zeichenfolge aus einem übergeordneten Prozess an einen untergeordneten Prozess auf demselben Computer mithilfe von Named Pipes. In diesem Beispiel wird ein NamedPipeServerStream -Objekt in einem übergeordneten Prozess erstellt. Das NamedPipeServerStream -Objekt hat den PipeDirection Wert Out. Der Server wartet dann darauf, dass ein NamedPipeClientStream Objekt in einem untergeordneten Prozess eine Verbindung damit herstellt. In diesem Beispiel befinden sich beide Prozesse auf demselben Computer, und das NamedPipeClientStream Objekt hat den PipeDirection Wert In. Der übergeordnete Prozess sendet daraufhin eine vom Benutzer bereitgestellte Zeichenfolge an den untergeordneten Prozess. Die Zeichenfolge wird in der Konsole angezeigt.

Dieses Beispiel bezieht sich auf den Clientprozess, der eine Verbindung mit dem Serverprozess herstellt. Das gesamte Codebeispiel, einschließlich des Codes für den Pipeclient und den Server, finden Sie unter How to: Use Named Pipes for Network Interprocess Communication.

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

Hinweise

Named Pipes stellen unidirektionale oder Duplexpipes für die Kommunikation zwischen einem Pipeserver und mindestens einem Pipeclient bereit. Named Pipes können für die prozessübergreifende Kommunikation lokal oder über ein Netzwerk verwendet werden. Ein einzelner Pipename kann von mehreren NamedPipeClientStream Objekten gemeinsam verwendet werden.

Jeder Prozess kann entweder als Named Pipe-Server oder -Client oder als beides fungieren.

Konstruktoren

NamedPipeClientStream(PipeDirection, Boolean, Boolean, SafePipeHandle)	Initialisiert eine neue Instanz der NamedPipeClientStream-Klasse für das angegebene Pipehandle mit der angegebenen Piperichtung.
NamedPipeClientStream(String)	Initialisiert eine neue Instanz der NamedPipeClientStream-Klasse mit dem angegebenen Pipenamen.
NamedPipeClientStream(String, String)	Initialisiert eine neue Instanz der NamedPipeClientStream-Klasse mit dem angegebenen Pipe- und Servernamen.
NamedPipeClientStream(String, String, PipeAccessRights, PipeOptions, TokenImpersonationLevel, HandleInheritability)	Initialisiert eine neue Instanz der NamedPipeClientStream-Klasse mit dem angegebenen Pipe- und Servernamen, den angegebenen Pipeoptionen, der angegebenen Ebene des Sicherheitsidentitätswechsels und dem angegebenen Vererbbarkeitsmodus.
NamedPipeClientStream(String, String, PipeDirection)	Initialisiert eine neue Instanz der NamedPipeClientStream-Klasse mit dem angegebenen Pipe- und Servernamen und der angegebenen Piperichtung.
NamedPipeClientStream(String, String, PipeDirection, PipeOptions)	Initialisiert eine neue Instanz der NamedPipeClientStream-Klasse mit dem angegebenen Pipe- und Servernamen, der angegebenen Piperichtung und den angegebenen Pipeoptionen.
NamedPipeClientStream(String, String, PipeDirection, PipeOptions, TokenImpersonationLevel)	Initialisiert eine neue Instanz der NamedPipeClientStream-Klasse mit dem angegebenen Pipe- und Servernamen, der angegebenen Piperichtung, den angegebenen Pipeoptionen und der angegebenen Ebene des Sicherheitsidentitätswechsels.
NamedPipeClientStream(String, String, PipeDirection, PipeOptions, TokenImpersonationLevel, HandleInheritability)	Initialisiert eine neue Instanz der NamedPipeClientStream-Klasse mit dem angegebenen Pipe- und Servernamen, der angegebenen Piperichtung, den angegebenen Pipeoptionen, der angegebenen Ebene des Sicherheitsidentitätswechsels und dem angegebenen Vererbbarkeitsmodus.

Eigenschaften

CanRead	Ruft einen Wert ab, der angibt, ob der aktuelle Stream Lesevorgänge unterstützt. (Geerbt von PipeStream)
CanSeek	Ruft einen Wert ab, der angibt, ob der aktuelle Stream Suchvorgänge unterstützt. (Geerbt von PipeStream)
CanTimeout	Ruft einen Wert ab, der bestimmt, ob für den aktuellen Stream ein Timeout möglich ist. (Geerbt von Stream)
CanWrite	Ruft einen Wert ab, der angibt, ob der aktuelle Stream Schreibvorgänge unterstützt. (Geerbt von PipeStream)
InBufferSize	Ruft die Größe des Eingangspuffers für eine Pipe in Bytes ab. (Geerbt von PipeStream)
IsAsync	Ruft einen Wert ab, der angibt, ob ein PipeStream -Objekt asynchron oder synchron geöffnet wurde. (Geerbt von PipeStream)
IsConnected	Ruft einen Wert ab, der angibt, ob ein PipeStream-Objekt verbunden ist, oder legt diesen fest. (Geerbt von PipeStream)
IsHandleExposed	Ruft einen Wert ab, der angibt, ob ein Handle für ein PipeStream-Objekt verfügbar gemacht wurde. (Geerbt von PipeStream)
IsMessageComplete	Ruft einen Wert ab, der angibt, ob in der vom letzten Lesevorgang zurückgegebenen Meldung weitere Daten vorhanden sind. (Geerbt von PipeStream)
Length	Ruft die Länge eines Streams in Bytes ab. (Geerbt von PipeStream)
NumberOfServerInstances	Ruft die Anzahl von Serverinstanzen mit dem gleichen Pipenamen ab.
OutBufferSize	Ruft die Größe des Ausgangspuffers für eine Pipe in Bytes ab. (Geerbt von PipeStream)
Position	Ruft die aktuelle Position des aktuellen Streams ab oder legt diese fest. (Geerbt von PipeStream)
ReadMode	Ruft den Lesemodus für ein PipeStream-Objekt ab oder legt diesen fest. (Geerbt von PipeStream)
ReadTimeout	Ruft einen Wert in Millisekunden ab, der bestimmt, wie lange der Stream versucht, Lesevorgänge durchzuführen, bevor ein Timeout auftritt, oder legt diesen fest. (Geerbt von Stream)
SafePipeHandle	Ruft das sichere Handle für das lokale Ende der Pipe ab, die vom aktuellen PipeStream-Objekt gekapselt wird. (Geerbt von PipeStream)
TransmissionMode	Ruft den von der aktuellen Pipe unterstützten Pipeübertragungsmodus ab. (Geerbt von PipeStream)
WriteTimeout	Ruft einen Wert in Millisekunden ab, der bestimmt, wie lange der Stream versucht, Schreibvorgänge durchzuführen, bevor ein Timeout auftritt, oder legt diesen fest. (Geerbt von Stream)

Methoden

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Beginnt einen asynchronen Lesevorgang. (Geerbt von PipeStream)
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Beginnt einen asynchronen Schreibvorgang. (Geerbt von PipeStream)
CheckPipePropertyOperations()	Überprüft, ob sich die Pipe in einem ordnungsgemäßen Zustand zum Abrufen oder Festlegen von Eigenschaften befindet. (Geerbt von PipeStream)
CheckReadOperations()	Überprüft, ob die Pipe verbunden ist, um Lesevorgänge auszuführen. (Geerbt von PipeStream)
CheckWriteOperations()	Überprüft, ob die Pipe verbunden ist, um Schreibvorgänge auszuführen. (Geerbt von PipeStream)
Close()	Schließt den aktuellen Stream und gibt alle dem aktuellen Stream zugeordneten Ressourcen frei (z. B. Sockets und Dateihandles). Anstatt diese Methode aufzurufen, stellen Sie sicher, dass der Stream ordnungsgemäß freigegeben wird. (Geerbt von Stream)
Connect()	Stellt eine Verbindung mit einem wartenden Server mit einem unendlichen Timeoutwert her.
Connect(Int32)	Stellt innerhalb des angegebenen Timeouts eine Verbindung mit einem wartenden Server her.
Connect(TimeSpan)	Stellt innerhalb des angegebenen Timeoutzeitraums eine Verbindung mit einem wartenden Server her.
ConnectAsync()	Stellt eine asynchrone Verbindung mit einem wartenden Server mit einem unendlichen Timeoutwert her.
ConnectAsync(CancellationToken)	Stellt eine asynchrone Verbindung mit einem wartenden Server her und überwacht Abbruchanforderungen.
ConnectAsync(Int32)	Stellt innerhalb des angegebenen Timeouts eine asynchrone Verbindung mit einem wartenden Server her.
ConnectAsync(Int32, CancellationToken)	Stellt innerhalb des angegebenen Timeouts eine asynchrone Verbindung mit einem wartenden Server her und überwacht Abbruchanforderungen.
ConnectAsync(TimeSpan, CancellationToken)	Stellt innerhalb des angegebenen Timeouts eine asynchrone Verbindung mit einem wartenden Server her und überwacht Abbruchanforderungen.
CopyTo(Stream)	Liest alle Bytes aus dem aktuellen Stream und schreibt sie in einen anderen Datenstrom. Beide Streamspositionen werden um die Anzahl der kopierten Bytes erweitert. (Geerbt von Stream)
CopyTo(Stream, Int32)	Liest alles Bytes aus dem aktuellen Datenstrom und schreibt sie unter Verwendung einer angegebenen Puffergröße in einen anderen Datenstrom. Beide Streamspositionen werden um die Anzahl der kopierten Bytes erweitert. (Geerbt von Stream)
CopyToAsync(Stream)	Liest die Bytes asynchron aus dem aktuellen Stream und schreibt sie in einen anderen Stream. Beide Streamspositionen werden um die Anzahl der kopierten Bytes erweitert. (Geerbt von Stream)
CopyToAsync(Stream, CancellationToken)	Liest die Bytes asynchron aus dem aktuellen Stream und schreibt sie unter Verwendung eines angegebenen Abbruchtokens in einen anderen Stream. Beide Streamspositionen werden um die Anzahl der kopierten Bytes erweitert. (Geerbt von Stream)
CopyToAsync(Stream, Int32)	Liest die Bytes asynchron aus dem aktuellen Stream und schreibt sie unter Verwendung einer angegebenen Puffergröße in einen anderen Stream. Beide Streamspositionen werden um die Anzahl der kopierten Bytes erweitert. (Geerbt von Stream)
CopyToAsync(Stream, Int32, CancellationToken)	Liest die Bytes asynchron aus dem aktuellen Stream und schreibt sie unter Verwendung einer angegebenen Puffergröße und eines Abbruchtokens in einen anderen Stream. Beide Streamspositionen werden um die Anzahl der kopierten Bytes erweitert. (Geerbt von Stream)
CreateObjRef(Type)	Erstellt ein Objekt mit allen relevanten Informationen, die zum Generieren eines Proxys für die Kommunikation mit einem Remoteobjekt erforderlich sind. (Geerbt von MarshalByRefObject)
CreateWaitHandle()	Veraltet. Veraltet. Veraltet. Reserviert ein WaitHandle-Objekt. (Geerbt von Stream)
Dispose()	Gibt alle vom Stream verwendeten Ressourcen frei. (Geerbt von Stream)
Dispose(Boolean)	Gibt die von der PipeStream-Klasse verwendeten nicht verwalteten Ressourcen frei und gibt (optional) auch die verwalteten Ressourcen frei. (Geerbt von PipeStream)
DisposeAsync()	Gibt die nicht verwalteten Ressourcen, die von der Stream verwendet werden, asynchron frei. (Geerbt von Stream)
EndRead(IAsyncResult)	Beendet eine ausstehende asynchrone Leseanforderung. (Geerbt von PipeStream)
EndWrite(IAsyncResult)	Beendet eine ausstehende asynchrone Schreibanforderung. (Geerbt von PipeStream)
Equals(Object)	Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object)
Finalize()	Gibt nicht verwaltete Ressourcen frei, und führt andere Bereinigungsvorgänge durch, bevor die NamedPipeClientStream-Instanz von der Garbage Collection freigegeben wird.
Flush()	Löscht den Puffer für den aktuellen Stream und veranlasst die Ausgabe aller gepufferten Daten an das zugrunde liegende Gerät. (Geerbt von PipeStream)
FlushAsync()	Löscht sämtliche Puffer für diesen Stream asynchron und veranlasst die Ausgabe aller gepufferten Daten an das zugrunde liegende Gerät. (Geerbt von Stream)
FlushAsync(CancellationToken)	Löscht den Puffer für den aktuellen Stream asynchron und veranlasst die Ausgabe aller gepufferten Daten an das zugrunde liegende Gerät. (Geerbt von PipeStream)
GetAccessControl()	Ruft ein PipeSecurity-Objekt ab, das die Einträge in der Zugriffssteuerungsliste für die Pipe kapselt, die vom aktuellen PipeStream-Objekt beschrieben wird. (Geerbt von PipeStream)
GetHashCode()	Fungiert als Standardhashfunktion. (Geerbt von Object)
GetLifetimeService()	Veraltet. Ruft das aktuelle Lebensdauerdienstobjekt ab, das die Lebensdauerrichtlinien für diese Instanz steuert. (Geerbt von MarshalByRefObject)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
InitializeHandle(SafePipeHandle, Boolean, Boolean)	Initialisiert ein PipeStream-Objekt aus dem angegebenen SafePipeHandle-Objekt. (Geerbt von PipeStream)
InitializeLifetimeService()	Veraltet. Ruft ein Lebensdauerdienstobjekt zur Steuerung der Lebensdauerrichtlinie für diese Instanz ab. (Geerbt von MarshalByRefObject)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
MemberwiseClone(Boolean)	Erstellt eine flache Kopie des aktuellen MarshalByRefObject-Objekts. (Geerbt von MarshalByRefObject)
ObjectInvariant()	Veraltet. Bietet Unterstützung für einen Contract. (Geerbt von Stream)
Read(Byte[], Int32, Int32)	Liest einen Block von Bytes aus einem Stream und schreibt die Daten ab einer angegebenen Position für eine angegebene Länge in einen angegebenen Puffer. (Geerbt von PipeStream)
Read(Span<Byte>)	Liest eine Folge von Bytes aus dem aktuellen Stream, schreibt sie in ein Bytearray und erhöht die Position innerhalb des Streams um die Anzahl der gelesenen Bytes. (Geerbt von PipeStream)
ReadAsync(Byte[], Int32, Int32)	Liest eine Bytesequenz asynchron aus dem aktuellen Stream und setzt die Position in diesem Stream um die Anzahl der gelesenen Bytes nach vorn. (Geerbt von Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Liest eine Folge von Bytes asynchron aus dem aktuellen Stream in ein Bytearray an die angegebene Position für eine angegebene Anzahl von Bytes, erhöht die Position im Stream um die Anzahl der gelesenen Bytes und überwacht Abbruchanfragen. (Geerbt von PipeStream)
ReadAsync(Memory<Byte>, CancellationToken)	Liest eine Folge von Bytes asynchron aus dem aktuellen Stream, schreibt diese in einen Bytespeicherbereich, erhöht die Position im Stream um die Anzahl der gelesenen Bytes und überwacht Abbruchanfragen. (Geerbt von PipeStream)
ReadAtLeast(Span<Byte>, Int32, Boolean)	Liest mindestens eine Mindestanzahl von Bytes aus dem aktuellen Stream und erhöht die Position innerhalb des Datenstroms um die Anzahl der gelesenen Bytes. (Geerbt von Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Liest asynchron mindestens eine Mindestanzahl von Bytes aus dem aktuellen Stream, erhöht die Position innerhalb des Datenstroms um die Anzahl der gelesenen Bytes und überwacht Abbruchanforderungen. (Geerbt von Stream)
ReadByte()	Liest ein Byte aus einer Pipe. (Geerbt von PipeStream)
ReadExactly(Byte[], Int32, Int32)	Liest `count` die Anzahl der Bytes aus dem aktuellen Stream und erhöht die Position innerhalb des Datenstroms. (Geerbt von Stream)
ReadExactly(Span<Byte>)	Liest Bytes aus dem aktuellen Stream und erhöht die Position innerhalb des Datenstroms, bis der `buffer` gefüllt ist. (Geerbt von Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	Liest `count` asynchron die Anzahl von Bytes aus dem aktuellen Stream, erhöht die Position im Stream und überwacht Abbruchanforderungen. (Geerbt von Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	Liest Bytes asynchron aus dem aktuellen Stream, erhöht die Position innerhalb des Datenstroms, bis der `buffer` gefüllt ist, und überwacht Abbruchanforderungen. (Geerbt von Stream)
Seek(Int64, SeekOrigin)	Legt die aktuelle Position des aktuellen Streams auf den angegebenen Wert fest. (Geerbt von PipeStream)
SetAccessControl(PipeSecurity)	Wendet von einem PipeSecurity-Objekt angegebene Einträge in Zugriffssteuerungslisten auf die vom aktuellen PipeStream-Objekt angegebene Pipe an. (Geerbt von PipeStream)
SetLength(Int64)	Legt die Länge des aktuellen Streams auf den angegebenen Wert fest. (Geerbt von PipeStream)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)
WaitForPipeDrain()	Wartet, bis das andere Ende der Pipe alle gesendeten Bytes gelesen hat. (Geerbt von PipeStream)
Write(Byte[], Int32, Int32)	Schreibt einen Byteblock mit den Daten aus einem Puffer in den aktuellen Stream. (Geerbt von PipeStream)
Write(ReadOnlySpan<Byte>)	Schreibt eine Bytesequenz in den aktuellen Stream und setzt die aktuelle Position in diesem Stream um die Anzahl der geschriebenen Bytes nach vorn. (Geerbt von PipeStream)
WriteAsync(Byte[], Int32, Int32)	Schreibt eine Bytesequenz asynchron in den aktuellen Stream und setzt die aktuelle Position in diesem Stream um die Anzahl der geschriebenen Bytes nach vorn. (Geerbt von Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Schreibt eine angegebene Anzahl von Bytes aus einem Bytearray ab einer angegebenen Position, erhöht die aktuelle Position in diesem Stream um die Anzahl der geschriebenen Bytes und überwacht Abbruchanforderungen. (Geerbt von PipeStream)
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Schreibt beim Überschreiben in einer abgeleiteten Klasse eine Folge von Bytes asynchron in den aktuellen Stream und erhöht die aktuelle Position im Stream um die Anzahl der geschriebenen Bytes und überwacht Abbruchanforderungen. (Geerbt von PipeStream)
WriteByte(Byte)	Schreibt ein Byte in den aktuellen Stream. (Geerbt von PipeStream)

Erweiterungsmethoden

CopyToAsync(Stream, PipeWriter, CancellationToken)	Liest die Bytes asynchron aus der Stream-Klasse und schreibt sie unter Verwendung eines Abbruchtokens in die angegebene PipeWriter-Klasse.
GetAccessControl(PipeStream)	Gibt die Sicherheitsinformationen eines Pipestreams zurück
SetAccessControl(PipeStream, PipeSecurity)	Ändert die Sicherheitsattribute eines vorhandenen Pipestreams
ConfigureAwait(IAsyncDisposable, Boolean)	Konfiguriert, wie Wartezeiten auf die Aufgaben angewandt werden, die von einem asynchronen verwerfbaren Element zurückgegeben werden.

Gilt für: