AnonymousPipeClientStream Třída

Definice

Obor názvů:

System.IO.Pipes

Sestavení:

System.IO.Pipes.dll

Zdroj:

AnonymousPipeClientStream.cs

Zpřístupňuje klientskou stranu anonymního datového proudu kanálu, který podporuje synchronní i asynchronní operace čtení a zápisu (bez podpory zrušení na platformách 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

Dědičnost

Object

MarshalByRefObject

Stream

PipeStream

AnonymousPipeClientStream

Příklady

Následující příklad odešle řetězec z nadřazeného procesu do podřízeného procesu pomocí anonymních kanálů. Tento příklad vytvoří AnonymousPipeServerStream objekt v nadřazeného procesu s PipeDirection hodnotou Out. Vytvoří také AnonymousPipeClientStream objekt v podřízené procesu s PipeDirection hodnotou In. Nadřazený proces poté odešle řetězec zadaný uživatelem podřízenému procesu. Řetězec se zobrazí v konzole nástroje .

Tento příklad je určený pro proces klienta, který spouští serverový proces. Při spuštění tohoto příkladu pojmenujte výsledný spustitelný soubor z klientského kódu pipeClient.exe a zkopírujte ho do stejného adresáře jako spustitelný soubor serveru. Celý příklad kódu, včetně kódu pro klienta kanálu i server, najdete v tématu Postupy: Použití anonymních kanálů pro místní komunikaci mezi procesy.

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

Poznámky

Anonymní kanály pomáhají zajistit bezpečnou a zabezpečenou komunikaci mezi procesy mezi podřízenými a nadřazenými procesy. Třída AnonymousPipeClientStream umožňuje podřízeného procesu připojit se a vyměňovat si informace s nadřazeným procesem.

Anonymní kanály jsou nepojmenované jednosměrné kanály, které obvykle přenášejí data mezi nadřazeným a podřízeným procesem. Anonymní kanály jsou vždy místní; nelze je používat přes síť. PipeDirection Hodnota InOut není podporována, protože anonymní kanály jsou definovány jako jednosměrné.

Anonymní kanály nepodporují PipeTransmissionMode.Message režim čtení.

Klientská strana anonymního kanálu musí být vytvořena z popisovače kanálu poskytnutého serverem voláním GetClientHandleAsString metody . Řetězec se pak předá jako parametr při vytváření procesu klienta. Z procesu klienta se předá konstruktoru AnonymousPipeClientStreampipeHandleAsString jako parametr .

Ve Windows anonymní kanály nepodporují asynchronní (překrývající se) operace čtení a zápisu (viz https://docs.microsoft.com/en-us/windows/win32/ipc/anonymous-pipe-operations). Třída AnonymousPipeClientStream bude stále plánovat práci ve fondu vláken na platformách Windows, takže asynchronní Stream operace fungují, ale zrušení těchto operací není podporováno.

Konstruktory

AnonymousPipeClientStream(PipeDirection, SafePipeHandle)	Inicializuje novou instanci AnonymousPipeClientStream třídy ze zadaného popisovače.
AnonymousPipeClientStream(PipeDirection, String)	Inicializuje novou instanci AnonymousPipeClientStream třídy se zadaným směrem kanálu a řetězcové vyjádření popisovače kanálu.
AnonymousPipeClientStream(String)	Inicializuje novou instanci AnonymousPipeClientStream třídy se zadaným řetězcovým vyjádřením popisovače kanálu.

Vlastnosti

CanRead	Získá hodnotu označující, zda aktuální datový proud podporuje operace čtení. (Zděděno od PipeStream)
CanSeek	Získá hodnotu označující, zda aktuální datový proud podporuje operace hledání. (Zděděno od PipeStream)
CanTimeout	Získá hodnotu, která určuje, zda aktuální datový proud může vypršení časového limitu. (Zděděno od Stream)
CanWrite	Získá hodnotu označující, zda aktuální datový proud podporuje operace zápisu. (Zděděno od PipeStream)
InBufferSize	Získá velikost v bajtech příchozí vyrovnávací paměti pro kanál. (Zděděno od PipeStream)
IsAsync	Získá hodnotu označující, zda PipeStream objekt byl otevřen asynchronně nebo synchronně. (Zděděno od PipeStream)
IsConnected	Získá nebo nastaví hodnotu označující, zda PipeStream je objekt připojen. (Zděděno od PipeStream)
IsHandleExposed	Získá hodnotu označující, zda je vystaven popisovač objektu PipeStream . (Zděděno od PipeStream)
IsMessageComplete	Získá hodnotu označující, zda je více dat ve zprávě vrácena z poslední operace čtení. (Zděděno od PipeStream)
Length	Získá délku datového proudu v bajtech. (Zděděno od PipeStream)
OutBufferSize	Získá velikost v bajtech odchozí vyrovnávací paměti pro kanál. (Zděděno od PipeStream)
Position	Získá nebo nastaví aktuální pozici aktuálního datového proudu. (Zděděno od PipeStream)
ReadMode	Nastaví režim čtení objektu AnonymousPipeClientStream .
ReadTimeout	Získá nebo nastaví hodnotu v milisekundách, která určuje, jak dlouho se datový proud pokusí číst před vypršením časového limitu. (Zděděno od Stream)
SafePipeHandle	Získá bezpečný popisovač pro místní konec potrubí, který aktuální PipeStream objekt zapouzdřuje. (Zděděno od PipeStream)
TransmissionMode	Získá režim přenosu potrubí podporovaný aktuálním kanálem.
WriteTimeout	Získá nebo nastaví hodnotu v milisekundách, která určuje, jak dlouho se datový proud pokusí zapisovat před vypršením časového limitu. (Zděděno od Stream)

Metody

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Zahájí asynchronní operaci čtení. (Zděděno od PipeStream)
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Zahájí asynchronní operaci zápisu. (Zděděno od PipeStream)
CheckPipePropertyOperations()	Ověří, že kanál je ve správném stavu pro získání nebo nastavení vlastností. (Zděděno od PipeStream)
CheckReadOperations()	Ověří, že kanál je v připojeném stavu pro operace čtení. (Zděděno od PipeStream)
CheckWriteOperations()	Ověřuje, že kanál je v připojeném stavu pro operace zápisu. (Zděděno od PipeStream)
Close()	Zavře aktuální datový proud a uvolní všechny prostředky (například sokety a popisovače souborů) přidružené k aktuálnímu datovému proudu. Místo volání této metody se ujistěte, že datový proud je správně odstraněn. (Zděděno od Stream)
CopyTo(Stream)	Přečte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů. (Zděděno od Stream)
CopyTo(Stream, Int32)	Načte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu s použitím zadané velikosti vyrovnávací paměti. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů. (Zděděno od Stream)
CopyToAsync(Stream)	Asynchronně čte bajty z aktuálního datového proudu a zapisuje je do jiného datového proudu. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů. (Zděděno od Stream)
CopyToAsync(Stream, CancellationToken)	Asynchronně přečte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu pomocí zadaného tokenu zrušení. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů. (Zděděno od Stream)
CopyToAsync(Stream, Int32)	Asynchronně čte bajty z aktuálního datového proudu a zapisuje je do jiného datového proudu pomocí zadané velikosti vyrovnávací paměti. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů. (Zděděno od Stream)
CopyToAsync(Stream, Int32, CancellationToken)	Asynchronně čte bajty z aktuálního datového proudu a zapisuje je do jiného datového proudu pomocí zadané velikosti vyrovnávací paměti a tokenu zrušení. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů. (Zděděno od Stream)
CreateObjRef(Type)	Vytvoří objekt, který obsahuje všechny relevantní informace potřebné k vygenerování proxy sloužící ke komunikaci se vzdáleným objektem. (Zděděno od MarshalByRefObject)
CreateWaitHandle()	Zastaralé. Přidělí WaitHandle objekt. (Zděděno od Stream)
Dispose()	Uvolní všechny prostředky používané nástrojem Stream. (Zděděno od Stream)
Dispose(Boolean)	Uvolní nespravované prostředky používané PipeStream třídou a volitelně uvolní spravované prostředky. (Zděděno od PipeStream)
DisposeAsync()	Asynchronně uvolní nespravované prostředky, které Streampoužívá . (Zděděno od Stream)
EndRead(IAsyncResult)	Ukončí čekající asynchronní požadavek na čtení. (Zděděno od PipeStream)
EndWrite(IAsyncResult)	Ukončí čekající asynchronní požadavek na zápis. (Zděděno od PipeStream)
Equals(Object)	Určí, zda se zadaný objekt rovná aktuálnímu objektu. (Zděděno od Object)
Finalize()	Uvolní nespravované prostředky a provede další operace čištění před uvolněním AnonymousPipeClientStream instance uvolňováním paměti.
Flush()	Vymaže vyrovnávací paměť pro aktuální datový proud a způsobí zápis všech dat do vyrovnávací paměti do základního zařízení. (Zděděno od PipeStream)
FlushAsync()	Asynchronně vymaže všechny vyrovnávací paměti pro tento datový proud a způsobí zápis všech dat do vyrovnávací paměti do základního zařízení. (Zděděno od Stream)
FlushAsync(CancellationToken)	Asynchronně vymaže vyrovnávací paměť pro aktuální datový proud a způsobí zápis všech dat do vyrovnávací paměti do základního zařízení. (Zděděno od PipeStream)
GetAccessControl()	PipeSecurity Získá objekt, který zapouzdřuje položky seznamu řízení přístupu (ACL) pro potrubí popsané aktuálním PipeStream objektem. (Zděděno od PipeStream)
GetHashCode()	Slouží jako výchozí hashovací funkce. (Zděděno od Object)
GetLifetimeService()	Zastaralé. Načte aktuální životnost objektu služby, který řídí zásady životnosti pro tuto instanci. (Zděděno od MarshalByRefObject)
GetType()	Type Získá z aktuální instance. (Zděděno od Object)
InitializeHandle(SafePipeHandle, Boolean, Boolean)	Inicializuje PipeStream objekt ze zadaného SafePipeHandle objektu. (Zděděno od PipeStream)
InitializeLifetimeService()	Zastaralé. Získá životnost objektu služby, který řídí zásady životnosti pro tuto instanci. (Zděděno od MarshalByRefObject)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
MemberwiseClone(Boolean)	Vytvoří mělkou kopii aktuálního MarshalByRefObject objektu. (Zděděno od MarshalByRefObject)
ObjectInvariant()	Zastaralé. Poskytuje podporu pro Contract. (Zděděno od Stream)
Read(Byte[], Int32, Int32)	Načte blok bajtů z datového proudu a zapíše data do zadané vyrovnávací paměti počínaje zadanou polohou na zadanou délku. (Zděděno od PipeStream)
Read(Span<Byte>)	Načte posloupnost bajtů z aktuálního datového proudu, zapíše je do pole bajtů a posune pozici v rámci datového proudu o počet přečtených bajtů. (Zděděno od PipeStream)
ReadAsync(Byte[], Int32, Int32)	Asynchronně přečte posloupnost bajtů z aktuálního datového proudu a posune pozici v rámci datového proudu o počet přečtených bajtů. (Zděděno od Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronně přečte sekvenci bajtů z aktuálního datového proudu do pole bajtů začínající na zadané pozici pro zadaný počet bajtů, posune pozici v rámci datového proudu o počet přečtených bajtů a sleduje požadavky na zrušení. (Zděděno od PipeStream)
ReadAsync(Memory<Byte>, CancellationToken)	Asynchronně přečte sekvenci bajtů z aktuálního datového proudu, zapíše ji do rozsahu bajtové paměti, posune pozici v rámci datového proudu o počet přečtených bajtů a monitoruje požadavky na zrušení. (Zděděno od PipeStream)
ReadAtLeast(Span<Byte>, Int32, Boolean)	Přečte alespoň minimální počet bajtů z aktuálního datového proudu a posune pozici v rámci datového proudu o počet přečtených bajtů. (Zděděno od Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Asynchronně přečte alespoň minimální počet bajtů z aktuálního datového proudu, posune pozici v rámci datového proudu o počet přečtených bajtů a sleduje požadavky na zrušení. (Zděděno od Stream)
ReadByte()	Načte bajt z svislé roury. (Zděděno od PipeStream)
ReadExactly(Byte[], Int32, Int32)	Načte count počet bajtů z aktuálního datového proudu a posune pozici v rámci datového proudu. (Zděděno od Stream)
ReadExactly(Span<Byte>)	Načte bajty z aktuálního datového proudu a posune pozici v rámci datového proudu, dokud buffer není vyplněna. (Zděděno od Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronně načte count počet bajtů z aktuálního datového proudu, posune pozici v rámci datového proudu a monitoruje požadavky na zrušení. (Zděděno od Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	Asynchronně čte bajty z aktuálního datového proudu, posune pozici v rámci datového proudu až do buffer vyplnění a monitoruje žádosti o zrušení. (Zděděno od Stream)
Seek(Int64, SeekOrigin)	Nastaví aktuální pozici aktuálního datového proudu na zadanou hodnotu. (Zděděno od PipeStream)
SetAccessControl(PipeSecurity)	Použije položky seznamu řízení přístupu (ACL) určené objektem PipeSecurity na kanál určený aktuálním PipeStream objektem. (Zděděno od PipeStream)
SetLength(Int64)	Nastaví délku aktuálního datového proudu na zadanou hodnotu. (Zděděno od PipeStream)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)
WaitForPipeDrain()	Čeká, až druhý konec kanálu přečte všechny odeslané bajty. (Zděděno od PipeStream)
Write(Byte[], Int32, Int32)	Zapíše blok bajtů do aktuálního datového proudu pomocí dat z vyrovnávací paměti. (Zděděno od PipeStream)
Write(ReadOnlySpan<Byte>)	Zapíše posloupnost bajtů do aktuálního datového proudu a posune aktuální pozici v rámci tohoto datového proudu o počet zapsaných bajtů. (Zděděno od PipeStream)
WriteAsync(Byte[], Int32, Int32)	Asynchronně zapíše posloupnost bajtů do aktuálního datového proudu a posune aktuální pozici v rámci tohoto datového proudu o počet zapsaných bajtů. (Zděděno od Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronně zapíše zadaný počet bajtů z bajtového pole počínaje zadanou pozicí, posune aktuální pozici v rámci tohoto datového proudu o počet zapsaných bajtů a sleduje požadavky zrušení. (Zděděno od PipeStream)
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Asynchronně zapíše sekvenci bajtů do aktuálního datového proudu, posune aktuální pozici v rámci tohoto datového proudu o počet zapsaných bajtů a sleduje požadavky na zrušení. (Zděděno od PipeStream)
WriteByte(Byte)	Zapíše bajt do aktuálního datového proudu. (Zděděno od PipeStream)

Metody rozšíření

CopyToAsync(Stream, PipeWriter, CancellationToken)	Asynchronně přečte bajty z objektu Stream a zapíše je do zadaného PipeWriterobjektu pomocí tokenu zrušení.
GetAccessControl(PipeStream)	Vrátí informace o zabezpečení datového proudu kanálu.
SetAccessControl(PipeStream, PipeSecurity)	Změní atributy zabezpečení existujícího datového proudu kanálu.
ConfigureAwait(IAsyncDisposable, Boolean)	Konfiguruje, jak se provádí funkce awaits u úloh vrácených z asynchronního jednorázového režimu.