AnonymousPipeClientStream Třída
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Zveřejňuje stranu klienta anonymního datového proudu kanálu, který podporuje synchronní i asynchronní operace čtení a zápisu (bez podpory zrušení na platformě 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
- Dědičnost
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ří objekt AnonymousPipeServerStream v nadřazený proces s PipeDirection hodnotou Out. Vytvoří také objekt AnonymousPipeClientStream v podřízeného procesu s PipeDirection hodnotou In. Nadřazený proces pak odešle do podřízeného procesu řetězec zadaný uživatelem. Řetězec se zobrazí v konzole.
Tento příklad je určený pro proces klienta, který je spuštěn procesem serveru. 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 při spuštění tohoto příkladu. Celý příklad kódu, včetně kódu pro klienta kanálu i serveru, najdete v tématu Postupy: Použití anonymních kanálů pro místní komunikaci meziprocesy.
//<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 podřízenými a nadřazeným procesy. Třída AnonymousPipeClientStream umožňuje podřízený proces připojit se a vyměňovat 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 procesy. Anonymní kanály jsou vždy místní; nelze je použít přes síť. PipeDirection hodnota InOut není podporována, protože anonymní kanály jsou definované tak, aby byly jednosměrné.
Anonymní kanály nepodporují režim PipeTransmissionMode.Message čtení.
Klientská strana anonymního kanálu musí být vytvořena z popisovače kanálu poskytovaného serverem voláním metody GetClientHandleAsString. Řetězec se pak předá jako parametr při vytváření procesu klienta. Z procesu klienta se předá konstruktoru AnonymousPipeClientStream jako parametr pipeHandleAsString
.
Anonymní kanály ve Windows nepodporují asynchronní (překrývající se) operace čtení a zápisu (viz operace anonymního kanálu). Třída AnonymousPipeClientStream bude pořád 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 třídy AnonymousPipeClientStream se zadaným směrem kanálu a řetězcovou reprezentací popisovače kanálu. |
AnonymousPipeClientStream(String) |
Inicializuje novou instanci AnonymousPipeClientStream třídy se zadaným řetězcovým znázorněným popisovačem kanálu. |
Vlastnosti
CanRead |
Získá hodnotu určující, zda aktuální datový proud podporuje operace čtení. (Zděděno od PipeStream) |
CanSeek |
Získá hodnotu urč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 určující, zda aktuální datový proud podporuje operace zápisu. (Zděděno od PipeStream) |
InBufferSize |
Získá velikost příchozí vyrovnávací paměti pro potrubí v bajtech. (Zděděno od PipeStream) |
IsAsync |
Získá hodnotu určující, zda PipeStream objekt byl otevřen asynchronně nebo synchronně. (Zděděno od PipeStream) |
IsConnected |
Získá nebo nastaví hodnotu určující, zda PipeStream objekt je připojen. (Zděděno od PipeStream) |
IsHandleExposed |
Získá hodnotu určující, zda popisovač PipeStream objekt je vystaven. (Zděděno od PipeStream) |
IsMessageComplete |
Získá hodnotu určující, zda je ve zprávě vrácených z poslední operace čtení více dat. (Zděděno od PipeStream) |
Length |
Získá délku datového proudu v bajtech. (Zděděno od PipeStream) |
OutBufferSize |
Získá velikost odchozí vyrovnávací paměti pro kanál v bajtech. (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í pro objekt AnonymousPipeClientStream. |
ReadTimeout |
Získá nebo nastaví hodnotu v milisekundách, která určuje, jak dlouho se datový proud pokusí přečíst před uplynutí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 potrubím. |
WriteTimeout |
Získá nebo nastaví hodnotu v milisekundách, která určuje, jak dlouho se datový proud pokusí zapsat před uplynutí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ěřuje, že kanál je ve správném stavu pro získání nebo nastavení vlastností. (Zděděno od PipeStream) |
CheckReadOperations() |
Ověřuje, ž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 je datový proud správně uvolně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ů jsou rozšířeny počtem bajtů zkopírovaných. (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 pomocí zadané velikosti vyrovnávací paměti. Obě pozice datových proudů jsou rozšířeny počtem bajtů zkopírovaných. (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ů jsou rozšířeny počtem bajtů zkopírovaných. (Zděděno od Stream) |
CopyToAsync(Stream, CancellationToken) |
Asynchronně čte bajty z aktuálního datového proudu a zapisuje je do jiného datového proudu pomocí zadaného tokenu zrušení. Obě pozice datových proudů jsou rozšířeny počtem bajtů zkopírovaných. (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ů jsou rozšířeny počtem bajtů zkopírovaných. (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ů jsou rozšířeny počtem bajtů zkopírovaných. (Zděděno od Stream) |
CreateObjRef(Type) |
Vytvoří objekt, který obsahuje všechny relevantní informace potřebné k vygenerování proxy serveru sloužícího ke komunikaci se vzdáleným objektem. (Zděděno od MarshalByRefObject) |
CreateWaitHandle() |
Zastaralé.
Zastaralé.
Zastaralé.
Přidělí objekt WaitHandle. (Zděděno od Stream) |
Dispose() |
Uvolní všechny prostředky používané 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 používané Stream. (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čuje, zda je zadaný objekt roven 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 paměti instance AnonymousPipeClientStream. |
Flush() |
Vymaže vyrovnávací paměť pro aktuální datový proud a způsobí zápis veškerých dat uložených do vyrovnávací paměti do podkladové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 uložených do vyrovnávací paměti do podkladové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 uložených dat do základního zařízení. (Zděděno od PipeStream) |
GetAccessControl() |
Získá PipeSecurity objekt, který zapouzdřuje položky seznamu řízení přístupu (ACL) pro kanál popsaný aktuálním objektem PipeStream. (Zděděno od PipeStream) |
GetHashCode() |
Slouží jako výchozí funkce hash. (Zděděno od Object) |
GetLifetimeService() |
Zastaralé.
Načte objekt služby aktuální životnosti, který řídí zásady životnosti pro tuto instanci. (Zděděno od MarshalByRefObject) |
GetType() |
Získá Type aktuální instance. (Zděděno od Object) |
InitializeHandle(SafePipeHandle, Boolean, Boolean) |
Inicializuje objekt PipeStream ze zadaného objektu SafePipeHandle. (Zděděno od PipeStream) |
InitializeLifetimeService() |
Zastaralé.
Získá objekt služby životnosti pro řízení zásad životnosti pro tuto instanci. (Zděděno od MarshalByRefObject) |
MemberwiseClone() |
Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object) |
MemberwiseClone(Boolean) |
Vytvoří mělkou kopii aktuálního objektu MarshalByRefObject. (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 pozicí pro zadanou délku. (Zděděno od PipeStream) |
Read(Span<Byte>) |
Přečte posloupnost bajtů z aktuálního datového proudu, zapíše je do bajtového pole a posune pozici v datovém proudu o počet přečtených bajtů. (Zděděno od PipeStream) |
ReadAsync(Byte[], Int32, Int32) |
Asynchronně čte posloupnost bajtů z aktuálního datového proudu a posune pozici v datovém proudu o počet přečtených bajtů. (Zděděno od Stream) |
ReadAsync(Byte[], Int32, Int32, CancellationToken) |
Asynchronně čte posloupnost bajtů z aktuálního datového proudu do bajtového pole počínaje zadanou pozicí pro zadaný počet bajtů, posune pozici v datovém proudu o počet přečtených bajtů a monitoruje žádosti o zrušení. (Zděděno od PipeStream) |
ReadAsync(Memory<Byte>, CancellationToken) |
Asynchronně čte posloupnost bajtů z aktuálního datového proudu, zapíše je do bajtového rozsahu paměti, posune pozici v datovém 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) |
Čte alespoň minimální počet bajtů z aktuálního datového proudu a posune pozici v datovém proudu o počet přečtených bajtů. (Zděděno od Stream) |
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken) |
Asynchronně č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 monitoruje žádosti o zrušení. (Zděděno od Stream) |
ReadByte() |
Přečte bajt z kanálu. (Zděděno od PipeStream) |
ReadExactly(Byte[], Int32, Int32) |
Přečte |
ReadExactly(Span<Byte>) |
Přečte bajty z aktuálního datového proudu a posune pozici v rámci datového proudu, dokud se |
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken) |
Asynchronně čte |
ReadExactlyAsync(Memory<Byte>, CancellationToken) |
Asynchronně čte bajty z aktuálního datového proudu, posune pozici v rámci datového proudu, dokud se |
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 objektem PipeStream objektu. (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á na druhý konec kanálu, aby přečetl 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 tomto datovém 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 tomto datovém 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 tomto datovém proudu o počet zapsaných bajtů a monitoruje žádosti o zrušení. (Zděděno od PipeStream) |
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken) |
Asynchronně zapíše posloupnost bajtů do aktuálního datového proudu, posune aktuální pozici v tomto datovém proudu o počet zapsaných bajtů a monitoruje žádosti o 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ě čte bajty z Stream a zapisuje je do zadané PipeWriterpomocí 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 čekají na úlohy vrácené z asynchronního jednorázového použití. |