AnonymousPipeClientStream クラス

リファレンス

定義

名前空間:: System.IO.Pipes

アセンブリ:: System.IO.Pipes.dll

アセンブリ:: System.Core.dll

アセンブリ:: netstandard.dll

ソース:: AnonymousPipeClientStream.cs

ソース:: AnonymousPipeClientStream.cs

ソース:: AnonymousPipeClientStream.cs

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

同期および非同期の読み取りと書き込みの両方の操作をサポートする匿名パイプストリームのクライアント側を公開します (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

継承: Object

Stream

PipeStream
AnonymousPipeClientStream

継承: Object

MarshalByRefObject

Stream

PipeStream
AnonymousPipeClientStream

例

次の例では、匿名パイプを使用して、親プロセスから子プロセスに文字列を送信します。次の使用例は、PipeDirection 値が Outの親プロセスに AnonymousPipeServerStream オブジェクトを作成します。また、PipeDirection 値が Inの子プロセスに AnonymousPipeClientStream オブジェクトも作成します。その後、親プロセスは、ユーザー指定の文字列を子プロセスに送信します。文字列がコンソールに表示されます。

この例は、サーバープロセスによって開始されるクライアントプロセスを対象としています。クライアントコード pipeClient.exe から結果の実行可能ファイルに名前を付け、この例を実行するときにサーバー実行可能ファイルと同じディレクトリにコピーします。パイプクライアントとサーバーの両方のコードを含むコード例全体については、「方法: ローカルプロセス間通信に匿名パイプを使用する」を参照してください。

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

注釈

匿名パイプは、子プロセスと親プロセス間の安全で安全なプロセス間通信を提供するのに役立ちます。 AnonymousPipeClientStream クラスを使用すると、子プロセスが親プロセスに接続して情報を交換できます。

匿名パイプは、親プロセスと子プロセスの間で通常データを転送する名前のない一方向パイプです。匿名パイプは常にローカルです。ネットワーク経由では使用できません。匿名パイプは一方向として定義されているため、InOut の PipeDirection 値はサポートされていません。

匿名パイプは、PipeTransmissionMode.Message 読み取りモードをサポートしていません。

匿名パイプのクライアント側は、GetClientHandleAsString メソッドを呼び出すことによって、サーバー側から提供されるパイプハンドルから作成する必要があります。この文字列は、クライアントプロセスの作成時にパラメーターとして渡されます。クライアントプロセスから、pipeHandleAsString パラメーターとして AnonymousPipeClientStream コンストラクターに渡されます。

Windows では、非同期 (重複) の読み取り操作と書き込み操作は匿名パイプではサポートされていません (匿名パイプ操作参照)。 AnonymousPipeClientStream クラスは引き続き Windows プラットフォーム上のスレッドプールでの作業をスケジュールするため、非同期 Stream 操作は機能しますが、それらの操作の取り消しはサポートされていません。

コンストラクター

AnonymousPipeClientStream(PipeDirection, SafePipeHandle)	指定したハンドルから AnonymousPipeClientStream クラスの新しいインスタンスを初期化します。
AnonymousPipeClientStream(PipeDirection, String)	指定したパイプ方向とパイプハンドルの文字列表現を使用して、AnonymousPipeClientStream クラスの新しいインスタンスを初期化します。
AnonymousPipeClientStream(String)	パイプハンドルの指定した文字列表現を使用して、AnonymousPipeClientStream クラスの新しいインスタンスを初期化します。

プロパティ

CanRead	現在のストリームが読み取り操作をサポートしているかどうかを示す値を取得します。 (継承元 PipeStream)
CanSeek	現在のストリームがシーク操作をサポートしているかどうかを示す値を取得します。 (継承元 PipeStream)
CanTimeout	現在のストリームがタイムアウトできるかどうかを決定する値を取得します。 (継承元 Stream)
CanWrite	現在のストリームが書き込み操作をサポートしているかどうかを示す値を取得します。 (継承元 PipeStream)
InBufferSize	パイプの受信バッファーのサイズ (バイト単位) を取得します。 (継承元 PipeStream)
IsAsync	PipeStream オブジェクトが非同期または同期的に開かれたかどうかを示す値を取得します。 (継承元 PipeStream)
IsConnected	PipeStream オブジェクトが接続されているかどうかを示す値を取得または設定します。 (継承元 PipeStream)
IsHandleExposed	PipeStream オブジェクトへのハンドルが公開されているかどうかを示す値を取得します。 (継承元 PipeStream)
IsMessageComplete	最新の読み取り操作から返されたメッセージに、さらに多くのデータがあるかどうかを示す値を取得します。 (継承元 PipeStream)
Length	ストリームの長さをバイト単位で取得します。 (継承元 PipeStream)
OutBufferSize	パイプの送信バッファーのサイズ (バイト単位) を取得します。 (継承元 PipeStream)
Position	現在のストリームの現在位置を取得または設定します。 (継承元 PipeStream)
ReadMode	AnonymousPipeClientStream オブジェクトの読み取りモードを設定します。
ReadTimeout	ストリームがタイムアウトするまでの読み取りを試行する時間を決定する値をミリ秒単位で取得または設定します。 (継承元 Stream)
SafePipeHandle	現在の PipeStream オブジェクトがカプセル化するパイプのローカル末尾のセーフハンドルを取得します。 (継承元 PipeStream)
TransmissionMode	現在のパイプでサポートされているパイプ伝送モードを取得します。
WriteTimeout	ストリームがタイムアウトするまでの書き込みを試行する時間を決定する値をミリ秒単位で取得または設定します。 (継承元 Stream)

メソッド

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	非同期読み取り操作を開始します。 (継承元 PipeStream)
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	非同期書き込み操作を開始します。 (継承元 PipeStream)
CheckPipePropertyOperations()	プロパティを取得または設定するためにパイプが適切な状態であることを確認します。 (継承元 PipeStream)
CheckReadOperations()	読み取り操作のためにパイプが接続状態であることを確認します。 (継承元 PipeStream)
CheckWriteOperations()	書き込み操作でパイプが接続状態であることを確認します。 (継承元 PipeStream)
Close()	現在のストリームを閉じ、現在のストリームに関連付けられているリソース (ソケットやファイルハンドルなど) を解放します。このメソッドを呼び出す代わりに、ストリームが適切に破棄されていることを確認します。 (継承元 Stream)
CopyTo(Stream)	現在のストリームからバイトを読み取り、別のストリームに書き込みます。どちらのストリーム位置も、コピーされたバイト数だけ進みます。 (継承元 Stream)
CopyTo(Stream, Int32)	現在のストリームからバイトを読み取り、指定されたバッファーサイズを使用して別のストリームに書き込みます。どちらのストリーム位置も、コピーされたバイト数だけ進みます。 (継承元 Stream)
CopyToAsync(Stream)	現在のストリームからバイトを非同期に読み取り、別のストリームに書き込みます。どちらのストリーム位置も、コピーされたバイト数だけ進みます。 (継承元 Stream)
CopyToAsync(Stream, CancellationToken)	現在のストリームからバイトを非同期に読み取り、指定されたキャンセルトークンを使用して別のストリームに書き込みます。どちらのストリーム位置も、コピーされたバイト数だけ進みます。 (継承元 Stream)
CopyToAsync(Stream, Int32)	現在のストリームからバイトを非同期に読み取り、指定されたバッファーサイズを使用して別のストリームに書き込みます。どちらのストリーム位置も、コピーされたバイト数だけ進みます。 (継承元 Stream)
CopyToAsync(Stream, Int32, CancellationToken)	指定したバッファーサイズとキャンセルトークンを使用して、現在のストリームからバイトを非同期に読み取り、別のストリームに書き込みます。どちらのストリーム位置も、コピーされたバイト数だけ進みます。 (継承元 Stream)
CreateObjRef(Type)	リモートオブジェクトとの通信に使用されるプロキシの生成に必要なすべての関連情報を含むオブジェクトを作成します。 (継承元 MarshalByRefObject)
CreateWaitHandle()	古い. 古い. 古い. WaitHandle オブジェクトを割り当てます。 (継承元 Stream)
Dispose()	Streamで使用されているすべてのリソースを解放します。 (継承元 Stream)
Dispose(Boolean)	PipeStream クラスによって使用されるアンマネージリソースを解放し、必要に応じてマネージドリソースを解放します。 (継承元 PipeStream)
DisposeAsync()	Streamによって使用されるアンマネージリソースを非同期的に解放します。 (継承元 Stream)
EndRead(IAsyncResult)	保留中の非同期読み取り要求を終了します。 (継承元 PipeStream)
EndWrite(IAsyncResult)	保留中の非同期書き込み要求を終了します。 (継承元 PipeStream)
Equals(Object)	指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
Finalize()	AnonymousPipeClientStream インスタンスがガベージコレクションによって再利用される前に、アンマネージリソースを解放し、その他のクリーンアップ操作を実行します。
Flush()	現在のストリームのバッファーをクリアし、バッファー内のデータを基になるデバイスに書き込みます。 (継承元 PipeStream)
FlushAsync()	このストリームのすべてのバッファーを非同期的にクリアし、バッファー内のデータを基になるデバイスに書き込みます。 (継承元 Stream)
FlushAsync(CancellationToken)	現在のストリームのバッファーを非同期的にクリアし、バッファー内のデータを基になるデバイスに書き込みます。 (継承元 PipeStream)
GetAccessControl()	現在の PipeStream オブジェクトによって記述されたパイプのアクセス制御リスト (ACL) エントリをカプセル化する PipeSecurity オブジェクトを取得します。 (継承元 PipeStream)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetLifetimeService()	古い. このインスタンスの有効期間ポリシーを制御する現在の有効期間サービスオブジェクトを取得します。 (継承元 MarshalByRefObject)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
InitializeHandle(SafePipeHandle, Boolean, Boolean)	指定した SafePipeHandle オブジェクトから PipeStream オブジェクトを初期化します。 (継承元 PipeStream)
InitializeLifetimeService()	古い. このインスタンスの有効期間ポリシーを制御する有効期間サービスオブジェクトを取得します。 (継承元 MarshalByRefObject)
MemberwiseClone()	現在の Objectの簡易コピーを作成します。 (継承元 Object)
MemberwiseClone(Boolean)	現在の MarshalByRefObject オブジェクトの簡易コピーを作成します。 (継承元 MarshalByRefObject)
ObjectInvariant()	古い. Contractのサポートを提供します。 (継承元 Stream)
Read(Byte[], Int32, Int32)	ストリームからバイトブロックを読み取り、指定した長さの指定した位置から始まる指定したバッファーにデータを書き込みます。 (継承元 PipeStream)
Read(Span<Byte>)	現在のストリームからバイトシーケンスを読み取り、バイト配列に書き込み、読み取ったバイト数だけストリーム内の位置を進めます。 (継承元 PipeStream)
ReadAsync(Byte[], Int32, Int32)	現在のストリームからバイトシーケンスを非同期に読み取り、ストリーム内の位置を読み取ったバイト数だけ進めます。 (継承元 Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	現在のストリームからバイト配列へのバイトシーケンスを、指定したバイト数の指定した位置から非同期に読み取り、ストリーム内の位置を読み取ったバイト数だけ進め、取り消し要求を監視します。 (継承元 PipeStream)
ReadAsync(Memory<Byte>, CancellationToken)	現在のストリームからバイトシーケンスを非同期に読み取り、バイトメモリ範囲に書き込み、読み取ったバイト数だけストリーム内の位置を進め、キャンセル要求を監視します。 (継承元 PipeStream)
ReadAtLeast(Span<Byte>, Int32, Boolean)	現在のストリームから少なくともバイト数を読み取り、読み取ったバイト数だけストリーム内の位置を進めます。 (継承元 Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	現在のストリームから少なくとも最小バイト数を非同期に読み取り、読み取ったバイト数だけストリーム内の位置を進め、キャンセル要求を監視します。 (継承元 Stream)
ReadByte()	パイプからバイトを読み取ります。 (継承元 PipeStream)
ReadExactly(Byte[], Int32, Int32)	現在のストリーム `count` バイト数を読み取り、ストリーム内の位置を進めます。 (継承元 Stream)
ReadExactly(Span<Byte>)	現在のストリームからバイトを読み取り、`buffer` がいっぱいになるまでストリーム内の位置を進めます。 (継承元 Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	現在のストリーム `count` バイト数を非同期に読み取り、ストリーム内の位置を進め、キャンセル要求を監視します。 (継承元 Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	現在のストリームからバイトを非同期に読み取り、`buffer` がいっぱいになるまでストリーム内の位置を進め、取り消し要求を監視します。 (継承元 Stream)
Seek(Int64, SeekOrigin)	現在のストリームの現在位置を指定した値に設定します。 (継承元 PipeStream)
SetAccessControl(PipeSecurity)	PipeSecurity オブジェクトで指定されたアクセス制御リスト (ACL) エントリを、現在の PipeStream オブジェクトで指定されたパイプに適用します。 (継承元 PipeStream)
SetLength(Int64)	現在のストリームの長さを指定した値に設定します。 (継承元 PipeStream)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)
WaitForPipeDrain()	パイプのもう一方の端が送信されたすべてのバイトを読み取るのを待機します。 (継承元 PipeStream)
Write(Byte[], Int32, Int32)	バッファーからのデータを使用して、現在のストリームにバイトブロックを書き込みます。 (継承元 PipeStream)
Write(ReadOnlySpan<Byte>)	現在のストリームにバイトシーケンスを書き込み、書き込まれたバイト数だけこのストリーム内の現在位置を進めます。 (継承元 PipeStream)
WriteAsync(Byte[], Int32, Int32)	現在のストリームにバイトシーケンスを非同期に書き込み、書き込まれたバイト数だけこのストリーム内の現在位置を進めます。 (継承元 Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	指定した位置から始まるバイト配列から、指定したバイト数を非同期に書き込み、書き込まれたバイト数だけこのストリーム内の現在位置を進め、キャンセル要求を監視します。 (継承元 PipeStream)
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	現在のストリームにバイトシーケンスを非同期に書き込み、書き込まれたバイト数だけこのストリーム内の現在位置を進め、キャンセル要求を監視します。 (継承元 PipeStream)
WriteByte(Byte)	現在のストリームにバイトを書き込みます。 (継承元 PipeStream)

拡張メソッド

CopyToAsync(Stream, PipeWriter, CancellationToken)	キャンセルトークンを使用して、Stream からバイトを非同期に読み取り、指定した PipeWriterに書き込みます。
GetAccessControl(PipeStream)	パイプストリームのセキュリティ情報を返します。
SetAccessControl(PipeStream, PipeSecurity)	既存のパイプストリームのセキュリティ属性を変更します。
ConfigureAwait(IAsyncDisposable, Boolean)	非同期破棄から返されるタスクの待機を実行する方法を構成します。

適用対象

次の方法で共有