NamedPipeClientStream Klasa

Definicja

Przestrzeń nazw:

System.IO.Pipes

Zestawy:

netstandard.dll, System.IO.Pipes.dll

Źródło:

NamedPipeClientStream.cs

Uwidacznia Stream wokół nazwanego potoku, który obsługuje zarówno synchroniczne, jak i asynchroniczne operacje odczytu i zapisu.

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

Dziedziczenie

Object

MarshalByRefObject

Stream

PipeStream

NamedPipeClientStream

Przykłady

W poniższym przykładzie pokazano sposób wysyłania ciągu z procesu nadrzędnego do procesu podrzędnego na tym samym komputerze przy użyciu nazwanych potoków. W tym przykładzie tworzony jest NamedPipeServerStream obiekt w procesie nadrzędnym. Obiekt NamedPipeServerStream ma PipeDirection wartość Out. Następnie serwer czeka na NamedPipeClientStream obiekt w procesie podrzędnym, aby nawiązać z nim połączenie. W tym przykładzie oba procesy znajdują się na tym samym komputerze, a NamedPipeClientStream obiekt ma PipeDirection wartość In. Proces nadrzędny wysyła następnie ciąg dostarczony przez użytkownika do procesu podrzędnego. Ciąg jest wyświetlany w konsoli programu .

Ten przykład dotyczy procesu klienta, który łączy się z procesem serwera. W przypadku całego przykładu kodu, w tym kodu dla klienta potoku i serwera, zobacz Instrukcje: używanie nazwanych potoków do komunikacji międzyprocesowej sieci.

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

Uwagi

Nazwane potoki zapewniają potoki jednokierunkowe lub dwukierunkowe do komunikacji między serwerem potoku a co najmniej jednym klientem potoku. Nazwane potoki mogą służyć do komunikacji międzyprocesowej lokalnie lub za pośrednictwem sieci. Pojedyncza nazwa potoku może być współdzielona przez wiele NamedPipeClientStream obiektów.

Każdy proces może działać jako nazwany serwer potoku lub klient albo oba te procesy.

Konstruktory

Nazwa	Opis
NamedPipeClientStream(PipeDirection, Boolean, Boolean, SafePipeHandle)	Inicjuje nowe wystąpienie NamedPipeClientStream klasy dla określonego uchwytu potoku z określonym kierunkiem potoku.
NamedPipeClientStream(String, String, PipeAccessRights, PipeOptions, TokenImpersonationLevel, HandleInheritability)	Inicjuje nowe wystąpienie NamedPipeClientStream klasy z określonymi nazwami potoków i serwerów oraz określonymi opcjami potoku, poziomem personifikacji zabezpieczeń i trybem dziedziczenia.
NamedPipeClientStream(String, String, PipeDirection, PipeOptions, TokenImpersonationLevel, HandleInheritability)	Inicjuje nowe wystąpienie NamedPipeClientStream klasy z określonymi nazwami potoków i serwerów oraz określony kierunek potoku, opcje potoku, poziom personifikacji zabezpieczeń i tryb dziedziczenia.
NamedPipeClientStream(String, String, PipeDirection, PipeOptions, TokenImpersonationLevel)	Inicjuje nowe wystąpienie NamedPipeClientStream klasy z określonymi nazwami potoku i serwera oraz określonym kierunkiem potoku, opcjami potoku i poziomem personifikacji zabezpieczeń.
NamedPipeClientStream(String, String, PipeDirection, PipeOptions)	Inicjuje nowe wystąpienie NamedPipeClientStream klasy z określonymi nazwami potoków i serwerów oraz określonymi opcjami kierunku potoku i potoku.
NamedPipeClientStream(String, String, PipeDirection)	Inicjuje nowe wystąpienie NamedPipeClientStream klasy z określonymi nazwami potoków i serwerów oraz określonym kierunkiem potoku.
NamedPipeClientStream(String, String)	Inicjuje nowe wystąpienie NamedPipeClientStream klasy z określonymi nazwami potoków i serwerów.
NamedPipeClientStream(String)	Inicjuje NamedPipeClientStream nowe wystąpienie klasy o określonej nazwie potoku.

Właściwości

Nazwa	Opis
CanRead	Pobiera wartość wskazującą, czy bieżący strumień obsługuje operacje odczytu. (Odziedziczone po PipeStream)
CanSeek	Pobiera wartość wskazującą, czy bieżący strumień obsługuje operacje wyszukiwania. (Odziedziczone po PipeStream)
CanTimeout	Pobiera wartość określającą, czy bieżący strumień może upłynął limit czasu. (Odziedziczone po Stream)
CanWrite	Pobiera wartość wskazującą, czy bieżący strumień obsługuje operacje zapisu. (Odziedziczone po PipeStream)
InBufferSize	Pobiera rozmiar w bajtach buforu przychodzącego dla potoku. (Odziedziczone po PipeStream)
IsAsync	Pobiera wartość wskazującą, czy PipeStream obiekt został otwarty asynchronicznie, czy synchronicznie. (Odziedziczone po PipeStream)
IsConnected	Pobiera lub ustawia wartość wskazującą PipeStream , czy obiekt jest połączony. (Odziedziczone po PipeStream)
IsHandleExposed	Pobiera wartość wskazującą, czy dojście do PipeStream obiektu jest uwidocznione. (Odziedziczone po PipeStream)
IsMessageComplete	Pobiera wartość wskazującą, czy w komunikacie zwróconym z najnowszej operacji odczytu jest więcej danych. (Odziedziczone po PipeStream)
Length	Pobiera długość strumienia w bajtach. (Odziedziczone po PipeStream)
NumberOfServerInstances	Pobiera liczbę wystąpień serwera, które mają taką samą nazwę potoku.
OutBufferSize	Pobiera rozmiar w bajtach buforu wychodzącego dla potoku. (Odziedziczone po PipeStream)
Position	Pobiera lub ustawia bieżącą pozycję bieżącego strumienia. (Odziedziczone po PipeStream)
ReadMode	Pobiera lub ustawia tryb odczytu dla PipeStream obiektu. (Odziedziczone po PipeStream)
ReadTimeout	Pobiera lub ustawia wartość w milisekundach, która określa, jak długo strumień będzie próbował odczytać przed upływem limitu czasu. (Odziedziczone po Stream)
SafePipeHandle	Pobiera bezpieczny uchwyt dla lokalnego końca potoku, który bieżący PipeStream obiekt hermetyzuje. (Odziedziczone po PipeStream)
TransmissionMode	Pobiera tryb transmisji potoku obsługiwany przez bieżący potok. (Odziedziczone po PipeStream)
WriteTimeout	Pobiera lub ustawia wartość w milisekundach, która określa, jak długo strumień będzie próbował zapisać przed upływem limitu czasu. (Odziedziczone po Stream)

Metody

Nazwa	Opis
BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Rozpoczyna operację odczytu asynchronicznego. (Odziedziczone po PipeStream)
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Rozpoczyna asynchroniczną operację zapisu. (Odziedziczone po PipeStream)
CheckPipePropertyOperations()	Sprawdza, czy potok jest w odpowiednim stanie do pobierania lub ustawiania właściwości. (Odziedziczone po PipeStream)
CheckReadOperations()	Sprawdza, czy potok jest w stanie połączonym dla operacji odczytu. (Odziedziczone po PipeStream)
CheckWriteOperations()	Sprawdza, czy potok jest w stanie połączonym dla operacji zapisu. (Odziedziczone po PipeStream)
Close()	Zamyka bieżący strumień i zwalnia wszystkie zasoby (takie jak gniazda i dojścia plików) skojarzone z bieżącym strumieniem. Zamiast wywoływać tę metodę, upewnij się, że strumień jest prawidłowo usuwany. (Odziedziczone po Stream)
Connect()	Łączy się z serwerem oczekującym z nieskończoną wartością limitu czasu.
Connect(Int32)	Łączy się z serwerem oczekującym w określonym przedziale czasu.
Connect(TimeSpan)	Łączy się z serwerem oczekującym w określonym przedziale czasu.
ConnectAsync()	Asynchronicznie łączy się z serwerem oczekującym z nieskończonym limitem czasu.
ConnectAsync(CancellationToken)	Asynchronicznie łączy się z serwerem oczekującym i monitoruje żądania anulowania.
ConnectAsync(Int32, CancellationToken)	Asynchronicznie łączy się z serwerem oczekującym w określonym przedziale czasu i monitoruje żądania anulowania.
ConnectAsync(Int32)	Asynchronicznie łączy się z serwerem oczekującym w określonym przedziale czasu.
ConnectAsync(TimeSpan, CancellationToken)	Asynchronicznie łączy się z serwerem oczekującym w określonym przedziale czasu i monitoruje żądania anulowania.
CopyTo(Stream, Int32)	Odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu przy użyciu określonego rozmiaru buforu. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyTo(Stream)	Odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyToAsync(Stream, CancellationToken)	Asynchronicznie odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu przy użyciu określonego tokenu anulowania. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyToAsync(Stream, Int32, CancellationToken)	Asynchronicznie odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu przy użyciu określonego rozmiaru buforu i tokenu anulowania. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyToAsync(Stream, Int32)	Asynchronicznie odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu przy użyciu określonego rozmiaru buforu. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyToAsync(Stream)	Asynchronicznie odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CreateWaitHandle()	Przestarzałe. WaitHandle Przydziela obiekt. (Odziedziczone po Stream)
Dispose()	Zwalnia wszystkie zasoby używane przez program Stream. (Odziedziczone po Stream)
Dispose(Boolean)	Zwalnia niezarządzane zasoby używane przez klasę PipeStream i opcjonalnie zwalnia zarządzane zasoby. (Odziedziczone po PipeStream)
DisposeAsync()	Asynchronicznie zwalnia niezarządzane zasoby używane przez program Stream. (Odziedziczone po Stream)
EndRead(IAsyncResult)	Kończy oczekujące żądanie odczytu asynchronicznego. (Odziedziczone po PipeStream)
EndWrite(IAsyncResult)	Kończy oczekujące żądanie asynchronicznego zapisu. (Odziedziczone po PipeStream)
Equals(Object)	Określa, czy określony obiekt jest równy bieżącemu obiektowi. (Odziedziczone po Object)
Finalize()	Zwalnia niezarządzane zasoby i wykonuje inne operacje oczyszczania przed NamedPipeClientStream odzyskaniem wystąpienia przez odzyskiwanie pamięci.
Flush()	Czyści bufor dla bieżącego strumienia i powoduje zapisanie wszystkich buforowanych danych na urządzeniu źródłowym. (Odziedziczone po PipeStream)
FlushAsync()	Asynchronicznie czyści wszystkie bufory dla tego strumienia i powoduje zapisanie wszystkich buforowanych danych na urządzeniu bazowym. (Odziedziczone po Stream)
FlushAsync(CancellationToken)	Asynchronicznie czyści bufor dla bieżącego strumienia i powoduje zapisanie wszystkich buforowanych danych na urządzeniu bazowym. (Odziedziczone po PipeStream)
GetHashCode()	Służy jako domyślna funkcja skrótu. (Odziedziczone po Object)
GetLifetimeService()	Przestarzałe. Pobiera bieżący obiekt usługi okresu istnienia, który kontroluje zasady okresu istnienia dla tego wystąpienia. (Odziedziczone po MarshalByRefObject)
GetType()	Pobiera Type bieżącego wystąpienia. (Odziedziczone po Object)
InitializeHandle(SafePipeHandle, Boolean, Boolean)	Inicjuje PipeStream obiekt z określonego SafePipeHandle obiektu. (Odziedziczone po PipeStream)
InitializeLifetimeService()	Przestarzałe. Uzyskuje obiekt usługi okresu istnienia w celu kontrolowania zasad okresu istnienia dla tego wystąpienia. (Odziedziczone po MarshalByRefObject)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Object. (Odziedziczone po Object)
MemberwiseClone(Boolean)	Tworzy płytkią kopię bieżącego MarshalByRefObject obiektu. (Odziedziczone po MarshalByRefObject)
ObjectInvariant()	Przestarzałe. Zapewnia obsługę elementu Contract. (Odziedziczone po Stream)
Read(Byte[], Int32, Int32)	Odczytuje blok bajtów ze strumienia i zapisuje dane w określonym buforze rozpoczynającym się od określonej pozycji dla określonej długości. (Odziedziczone po PipeStream)
Read(Span<Byte>)	Odczytuje sekwencję bajtów z bieżącego strumienia, zapisuje je w tablicy bajtów i rozwija pozycję w strumieniu według liczby odczytanych bajtów. (Odziedziczone po PipeStream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia do tablicy bajtów rozpoczynającej się od określonej liczby bajtów, przechodzi pozycję w strumieniu według liczby odczytanych bajtów i monitoruje żądania anulowania. (Odziedziczone po PipeStream)
ReadAsync(Byte[], Int32, Int32)	Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia i rozwija pozycję w strumieniu według liczby odczytanych bajtów. (Odziedziczone po Stream)
ReadAsync(Memory<Byte>, CancellationToken)	Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia, zapisuje je w zakresie pamięci bajtów, rozwija pozycję w strumieniu według liczby odczytanych bajtów i monitoruje żądania anulowania. (Odziedziczone po PipeStream)
ReadAtLeast(Span<Byte>, Int32, Boolean)	Odczytuje co najmniej minimalną liczbę bajtów z bieżącego strumienia i rozwija pozycję w strumieniu według liczby odczytanych bajtów. (Odziedziczone po Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Asynchronicznie odczytuje co najmniej minimalną liczbę bajtów z bieżącego strumienia, zwiększa pozycję w strumieniu przez liczbę odczytanych bajtów i monitoruje żądania anulowania. (Odziedziczone po Stream)
ReadByte()	Odczytuje bajt z potoku. (Odziedziczone po PipeStream)
ReadExactly(Byte[], Int32, Int32)	Odczytuje count liczbę bajtów z bieżącego strumienia i rozwija pozycję w strumieniu. (Odziedziczone po Stream)
ReadExactly(Span<Byte>)	Odczytuje bajty z bieżącego strumienia i przechodzi do momentu wypełnienia pozycji w strumieniu buffer . (Odziedziczone po Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronicznie odczytuje count liczbę bajtów z bieżącego strumienia, rozwija pozycję w strumieniu i monitoruje żądania anulowania. (Odziedziczone po Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	Asynchronicznie odczytuje bajty z bieżącego strumienia, przechodzi pozycję w strumieniu do buffer momentu wypełnienia i monitoruje żądania anulowania. (Odziedziczone po Stream)
Seek(Int64, SeekOrigin)	Ustawia bieżące położenie bieżącego strumienia na określoną wartość. (Odziedziczone po PipeStream)
SetLength(Int64)	Ustawia długość bieżącego strumienia na określoną wartość. (Odziedziczone po PipeStream)
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)
WaitForPipeDrain()	Czeka na drugi koniec potoku, aby odczytać wszystkie wysłane bajty. (Odziedziczone po PipeStream)
Write(Byte[], Int32, Int32)	Zapisuje blok bajtów w bieżącym strumieniu przy użyciu danych z buforu. (Odziedziczone po PipeStream)
Write(ReadOnlySpan<Byte>)	Zapisuje sekwencję bajtów w bieżącym strumieniu i przechodzi bieżącą pozycję w tym strumieniu przez liczbę zapisanych bajtów. (Odziedziczone po PipeStream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronicznie zapisuje określoną liczbę bajtów z tablicy bajtów rozpoczynającej się od określonej pozycji, przechodzi bieżącą pozycję w tym strumieniu przez liczbę zapisanych bajtów i monitoruje żądania anulowania. (Odziedziczone po PipeStream)
WriteAsync(Byte[], Int32, Int32)	Asynchronicznie zapisuje sekwencję bajtów do bieżącego strumienia i przechodzi bieżącą pozycję w tym strumieniu przez liczbę zapisanych bajtów. (Odziedziczone po Stream)
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Asynchronicznie zapisuje sekwencję bajtów w bieżącym strumieniu, przechodzi bieżącą pozycję w tym strumieniu przez liczbę zapisanych bajtów i monitoruje żądania anulowania. (Odziedziczone po PipeStream)
WriteByte(Byte)	Zapisuje bajt do bieżącego strumienia. (Odziedziczone po PipeStream)

Metody rozszerzania

Nazwa	Opis
ConfigureAwait(IAsyncDisposable, Boolean)	Konfiguruje, w jaki sposób będą wykonywane oczekiwania na zadania zwrócone z asynchronicznego jednorazowego użytku.
CopyToAsync(Stream, PipeWriter, CancellationToken)	Asynchronicznie odczytuje bajty z obiektu Stream i zapisuje je w określonym PipeWriterobiekcie przy użyciu tokenu anulowania.
GetAccessControl(PipeStream)	Zwraca informacje o zabezpieczeniach strumienia potoku.
SetAccessControl(PipeStream, PipeSecurity)	Zmienia atrybuty zabezpieczeń istniejącego strumienia potoku.