AnonymousPipeServerStream Class

Definition

Namespace:

System.IO.Pipes

Assembly:

System.IO.Pipes.dll

Source:

AnonymousPipeServerStream.cs

Exposes a stream around an anonymous pipe, which supports both synchronous and asynchronous read and write operations.

public ref class AnonymousPipeServerStream sealed : System::IO::Pipes::PipeStream

public sealed class AnonymousPipeServerStream : System.IO.Pipes.PipeStream

type AnonymousPipeServerStream = class
    inherit PipeStream

Public NotInheritable Class AnonymousPipeServerStream
Inherits PipeStream

Inheritance

Object

MarshalByRefObject

Stream

PipeStream

AnonymousPipeServerStream

Examples

The following example sends a string from a parent process to a child process using anonymous pipes. This example creates an AnonymousPipeServerStream object in a parent process with a PipeDirection value of PipeDirection.Out. It also creates an AnonymousPipeClientStream object in a child process with a PipeDirection value of PipeDirection.In. The parent process then sends a user-supplied string to the child process. The string is displayed to the console.

This example is for the server process, which uses the AnonymousPipeServerStream class. For the entire code example, including the code for both the pipe client and server, see How to: Use Anonymous Pipes for Local Interprocess Communication.

//<snippet01>
#using <System.dll>
#using <System.Core.dll>

using namespace System;
using namespace System::IO;
using namespace System::IO::Pipes;
using namespace System::Diagnostics;

ref class PipeServer
{
public:
    static void Main()
    {
        Process^ pipeClient = gcnew Process();

        pipeClient->StartInfo->FileName = "pipeClient.exe";

        AnonymousPipeServerStream^ pipeServer =
            gcnew AnonymousPipeServerStream(PipeDirection::Out,
            HandleInheritability::Inheritable);

        Console::WriteLine("[SERVER] Current TransmissionMode: {0}.",
            pipeServer->TransmissionMode);

        // Pass the client process a handle to the server.
        pipeClient->StartInfo->Arguments =
            pipeServer->GetClientHandleAsString();
        pipeClient->StartInfo->UseShellExecute = false;
        pipeClient->Start();

        pipeServer->DisposeLocalCopyOfClientHandle();

        try
        {
            // Read user input and send that to the client process.
            StreamWriter^ sw = gcnew StreamWriter(pipeServer);

            sw->AutoFlush = true;
            // Send a 'sync message' and wait for client to receive it.
            sw->WriteLine("SYNC");
            pipeServer->WaitForPipeDrain();
            // Send the console input to the client process.
            Console::Write("[SERVER] Enter text: ");
            sw->WriteLine(Console::ReadLine());
            sw->Close();
        }
        // Catch the IOException that is raised if the pipe is broken
        // or disconnected.
        catch (IOException^ e)
        {
            Console::WriteLine("[SERVER] Error: {0}", e->Message);
        }
        pipeServer->Close();
        pipeClient->WaitForExit();
        pipeClient->Close();
        Console::WriteLine("[SERVER] Client quit. Server terminating.");
    }
};

int main()
{
    PipeServer::Main();
}
//</snippet01>

//<snippet01>
using System;
using System.IO;
using System.IO.Pipes;
using System.Diagnostics;

class PipeServer
{
    static void Main()
    {
        Process pipeClient = new Process();

        pipeClient.StartInfo.FileName = "pipeClient.exe";

        using (AnonymousPipeServerStream pipeServer =
            new AnonymousPipeServerStream(PipeDirection.Out,
            HandleInheritability.Inheritable))
        {
            Console.WriteLine("[SERVER] Current TransmissionMode: {0}.",
                pipeServer.TransmissionMode);

            // Pass the client process a handle to the server.
            pipeClient.StartInfo.Arguments =
                pipeServer.GetClientHandleAsString();
            pipeClient.StartInfo.UseShellExecute = false;
            pipeClient.Start();

            pipeServer.DisposeLocalCopyOfClientHandle();

            try
            {
                // Read user input and send that to the client process.
                using (StreamWriter sw = new StreamWriter(pipeServer))
                {
                    sw.AutoFlush = true;
                    // Send a 'sync message' and wait for client to receive it.
                    sw.WriteLine("SYNC");
                    pipeServer.WaitForPipeDrain();
                    // Send the console input to the client process.
                    Console.Write("[SERVER] Enter text: ");
                    sw.WriteLine(Console.ReadLine());
                }
            }
            // Catch the IOException that is raised if the pipe is broken
            // or disconnected.
            catch (IOException e)
            {
                Console.WriteLine("[SERVER] Error: {0}", e.Message);
            }
        }

        pipeClient.WaitForExit();
        pipeClient.Close();
        Console.WriteLine("[SERVER] Client quit. Server terminating.");
    }
}
//</snippet01>

'<snippet01>
Imports System.IO
Imports System.IO.Pipes
Imports System.Diagnostics

Class PipeServer
    Shared Sub Main()
        Dim pipeClient As New Process()

        pipeClient.StartInfo.FileName = "pipeClient.exe"

        Using pipeServer As New AnonymousPipeServerStream(PipeDirection.Out, _
            HandleInheritability.Inheritable)

            Console.WriteLine("[SERVER] Current TransmissionMode: {0}.",
                pipeServer.TransmissionMode)

            ' Pass the client process a handle to the server.
            pipeClient.StartInfo.Arguments = pipeServer.GetClientHandleAsString()
            pipeClient.StartInfo.UseShellExecute = false
            pipeClient.Start()

            pipeServer.DisposeLocalCopyOfClientHandle()

            Try
                ' Read user input and send that to the client process.
                Using sw As New StreamWriter(pipeServer)
                    sw.AutoFlush = true
                    ' Send a 'sync message' and wait for client to receive it.
                    sw.WriteLine("SYNC")
                    pipeServer.WaitForPipeDrain()
                    ' Send the console input to the client process.
                    Console.Write("[SERVER] Enter text: ")
                    sw.WriteLine(Console.ReadLine())
                End Using
            Catch e As IOException
                ' Catch the IOException that is raised if the pipe is broken
                ' or disconnected.
                Console.WriteLine("[SERVER] Error: {0}", e.Message)
            End Try
        End Using

        pipeClient.WaitForExit()
        pipeClient.Close()
        Console.WriteLine("[SERVER] Client quit. Server terminating.")
    End Sub
End Class
'</snippet01>

Remarks

Anonymous pipes help provide safe and secure interprocess communication between child and parent processes. The AnonymousPipeServerStream class enables a parent process to send or receive information from a child process.

Anonymous pipes are unnamed, one-way pipes that typically transfer data between parent and child processes. Anonymous pipes are always local; they cannot be used over a network. A PipeDirection value of InOut is not supported because anonymous pipes are defined to be one-way.

Anonymous pipes do not support the PipeTransmissionMode.Message read mode.

The client side of an anonymous pipe must be created from a pipe handle provided by the server side by calling the GetClientHandleAsString method. The string is then passed as a parameter when creating the client process. From the client process, it is then passed to the AnonymousPipeClientStream constructor as the pipeHandleAsString parameter.

The AnonymousPipeServerStream object must dispose the client handle using the DisposeLocalCopyOfClientHandle method in order to be notified when the client exits.

Constructors

AnonymousPipeServerStream()	Initializes a new instance of the AnonymousPipeServerStream class.
AnonymousPipeServerStream(PipeDirection, HandleInheritability, Int32)	Initializes a new instance of the AnonymousPipeServerStream class with the specified pipe direction, inheritability mode, and buffer size.
AnonymousPipeServerStream(PipeDirection, HandleInheritability)	Initializes a new instance of the AnonymousPipeServerStream class with the specified pipe direction and inheritability mode.
AnonymousPipeServerStream(PipeDirection, SafePipeHandle, SafePipeHandle)	Initializes a new instance of the AnonymousPipeServerStream class from the specified pipe handles.
AnonymousPipeServerStream(PipeDirection)	Initializes a new instance of the AnonymousPipeServerStream class with the specified pipe direction.

Properties

CanRead	Gets a value indicating whether the current stream supports read operations. (Inherited from PipeStream)
CanSeek	Gets a value indicating whether the current stream supports seek operations. (Inherited from PipeStream)
CanTimeout	Gets a value that determines whether the current stream can time out. (Inherited from Stream)
CanWrite	Gets a value indicating whether the current stream supports write operations. (Inherited from PipeStream)
ClientSafePipeHandle	Gets the safe handle for the AnonymousPipeClientStream object that is currently connected to the AnonymousPipeServerStream object.
InBufferSize	Gets the size, in bytes, of the inbound buffer for a pipe. (Inherited from PipeStream)
IsAsync	Gets a value indicating whether a PipeStream object was opened asynchronously or synchronously. (Inherited from PipeStream)
IsConnected	Gets or sets a value indicating whether a PipeStream object is connected. (Inherited from PipeStream)
IsHandleExposed	Gets a value indicating whether a handle to a PipeStream object is exposed. (Inherited from PipeStream)
IsMessageComplete	Gets a value indicating whether there is more data in the message returned from the most recent read operation. (Inherited from PipeStream)
Length	Gets the length of a stream, in bytes. (Inherited from PipeStream)
OutBufferSize	Gets the size, in bytes, of the outbound buffer for a pipe. (Inherited from PipeStream)
Position	Gets or sets the current position of the current stream. (Inherited from PipeStream)
ReadMode	Sets the reading mode for the AnonymousPipeServerStream object. For anonymous pipes, transmission mode must be Byte.
ReadTimeout	Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream)
SafePipeHandle	Gets the safe handle for the local end of the pipe that the current PipeStream object encapsulates. (Inherited from PipeStream)
TransmissionMode	Gets the pipe transmission mode that is supported by the current pipe.
WriteTimeout	Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream)

Methods

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Begins an asynchronous read operation. (Inherited from PipeStream)
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Begins an asynchronous write operation. (Inherited from PipeStream)
CheckPipePropertyOperations()	Verifies that the pipe is in a proper state for getting or setting properties. (Inherited from PipeStream)
CheckReadOperations()	Verifies that the pipe is in a connected state for read operations. (Inherited from PipeStream)
CheckWriteOperations()	Verifies that the pipe is in a connected state for write operations. (Inherited from PipeStream)
Close()	Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed. (Inherited from Stream)
CopyTo(Stream, Int32)	Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream)
CopyTo(Stream)	Reads the bytes from the current stream and writes them to another stream. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream)
CopyToAsync(Stream, CancellationToken)	Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified cancellation token. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream)
CopyToAsync(Stream, Int32, CancellationToken)	Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream)
CopyToAsync(Stream, Int32)	Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream)
CopyToAsync(Stream)	Asynchronously reads the bytes from the current stream and writes them to another stream. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream)
CreateObjRef(Type)	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject)
CreateWaitHandle()	Obsolete. Allocates a WaitHandle object. (Inherited from Stream)
Dispose()	Releases all resources used by the Stream. (Inherited from Stream)
Dispose(Boolean)	Releases the unmanaged resources used by the PipeStream class and optionally releases the managed resources. (Inherited from PipeStream)
DisposeAsync()	Asynchronously releases the unmanaged resources used by the Stream. (Inherited from Stream)
DisposeLocalCopyOfClientHandle()	Closes the local copy of the AnonymousPipeClientStream object's handle.
EndRead(IAsyncResult)	Ends a pending asynchronous read request. (Inherited from PipeStream)
EndWrite(IAsyncResult)	Ends a pending asynchronous write request. (Inherited from PipeStream)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize()	Releases unmanaged resources and performs other cleanup operations before the AnonymousPipeServerStream instance is reclaimed by garbage collection.
Flush()	Clears the buffer for the current stream and causes any buffered data to be written to the underlying device. (Inherited from PipeStream)
FlushAsync()	Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Inherited from Stream)
FlushAsync(CancellationToken)	Asynchronously clears the buffer for the current stream and causes any buffered data to be written to the underlying device. (Inherited from PipeStream)
GetAccessControl()	Gets a PipeSecurity object that encapsulates the access control list (ACL) entries for the pipe described by the current PipeStream object. (Inherited from PipeStream)
GetClientHandleAsString()	Gets the connected AnonymousPipeClientStream object's handle as a string.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetLifetimeService()	Obsolete. Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject)
GetType()	Gets the Type of the current instance. (Inherited from Object)
InitializeHandle(SafePipeHandle, Boolean, Boolean)	Initializes a PipeStream object from the specified SafePipeHandle object. (Inherited from PipeStream)
InitializeLifetimeService()	Obsolete. Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject)
ObjectInvariant()	Obsolete. Provides support for a Contract. (Inherited from Stream)
Read(Byte[], Int32, Int32)	Reads a block of bytes from a stream and writes the data to a specified buffer starting at a specified position for a specified length. (Inherited from PipeStream)
Read(Span<Byte>)	Reads a sequence of bytes from the current stream, writes them to a byte array, and advances the position within the stream by the number of bytes read. (Inherited from PipeStream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronously reads a sequence of bytes from the current stream to a byte array starting at a specified position for a specified number of bytes, advances the position within the stream by the number of bytes read, and monitors cancellation requests. (Inherited from PipeStream)
ReadAsync(Byte[], Int32, Int32)	Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. (Inherited from Stream)
ReadAsync(Memory<Byte>, CancellationToken)	Asynchronously reads a sequence of bytes from the current stream, writes them to a byte memory range, advances the position within the stream by the number of bytes read, and monitors cancellation requests. (Inherited from PipeStream)
ReadAtLeast(Span<Byte>, Int32, Boolean)	Reads at least a minimum number of bytes from the current stream and advances the position within the stream by the number of bytes read. (Inherited from Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Asynchronously reads at least a minimum number of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. (Inherited from Stream)
ReadByte()	Reads a byte from a pipe. (Inherited from PipeStream)
ReadExactly(Byte[], Int32, Int32)	Reads count number of bytes from the current stream and advances the position within the stream. (Inherited from Stream)
ReadExactly(Span<Byte>)	Reads bytes from the current stream and advances the position within the stream until the buffer is filled. (Inherited from Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronously reads count number of bytes from the current stream, advances the position within the stream, and monitors cancellation requests. (Inherited from Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	Asynchronously reads bytes from the current stream, advances the position within the stream until the buffer is filled, and monitors cancellation requests. (Inherited from Stream)
Seek(Int64, SeekOrigin)	Sets the current position of the current stream to the specified value. (Inherited from PipeStream)
SetAccessControl(PipeSecurity)	Applies the access control list (ACL) entries specified by a PipeSecurity object to the pipe specified by the current PipeStream object. (Inherited from PipeStream)
SetLength(Int64)	Sets the length of the current stream to the specified value. (Inherited from PipeStream)
ToString()	Returns a string that represents the current object. (Inherited from Object)
WaitForPipeDrain()	Waits for the other end of the pipe to read all sent bytes. (Inherited from PipeStream)
Write(Byte[], Int32, Int32)	Writes a block of bytes to the current stream using data from a buffer. (Inherited from PipeStream)
Write(ReadOnlySpan<Byte>)	Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. (Inherited from PipeStream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronously writes a specified number of bytes from a byte array starting at a specified position, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. (Inherited from PipeStream)
WriteAsync(Byte[], Int32, Int32)	Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. (Inherited from Stream)
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. (Inherited from PipeStream)
WriteByte(Byte)	Writes a byte to the current stream. (Inherited from PipeStream)

Extension Methods

CopyToAsync(Stream, PipeWriter, CancellationToken)	Asynchronously reads the bytes from the Stream and writes them to the specified PipeWriter, using a cancellation token.
GetAccessControl(PipeStream)	Returns the security information of a pipe stream.
SetAccessControl(PipeStream, PipeSecurity)	Changes the security attributes of an existing pipe stream.
ConfigureAwait(IAsyncDisposable, Boolean)	Configures how awaits on the tasks returned from an async disposable will be performed.