AnonymousPipeClientStream Class

AnonymousPipeClientStream Class

.NET Framework (current version)
 

Exposes the client side of an anonymous pipe stream, which supports both synchronous and asynchronous read and write operations.

Namespace:   System.IO.Pipes
Assembly:  System.Core (in System.Core.dll)

System.Object
  System.MarshalByRefObject
    System.IO.Stream
      System.IO.Pipes.PipeStream
        System.IO.Pipes.AnonymousPipeClientStream

[HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort = true)]
public sealed class AnonymousPipeClientStream : PipeStream

NameDescription
System_CAPS_pubmethodAnonymousPipeClientStream(PipeDirection, SafePipeHandle)

Initializes a new instance of the AnonymousPipeClientStream class from the specified handle.

System_CAPS_pubmethodAnonymousPipeClientStream(PipeDirection, String)

Initializes a new instance of the AnonymousPipeClientStream class with the specified pipe direction and a string representation of the pipe handle.

System_CAPS_pubmethodAnonymousPipeClientStream(String)

Initializes a new instance of the AnonymousPipeClientStream class with the specified string representation of the pipe handle.

NameDescription
System_CAPS_pubpropertyCanRead

Gets a value indicating whether the current stream supports read operations.(Inherited from PipeStream.)

System_CAPS_pubpropertyCanSeek

Gets a value indicating whether the current stream supports seek operations.(Inherited from PipeStream.)

System_CAPS_pubpropertyCanTimeout

Gets a value that determines whether the current stream can time out.(Inherited from Stream.)

System_CAPS_pubpropertyCanWrite

Gets a value indicating whether the current stream supports write operations.(Inherited from PipeStream.)

System_CAPS_pubpropertyInBufferSize

Gets the size, in bytes, of the inbound buffer for a pipe.(Inherited from PipeStream.)

System_CAPS_pubpropertyIsAsync

Gets a value indicating whether a PipeStream object was opened asynchronously or synchronously.(Inherited from PipeStream.)

System_CAPS_pubpropertyIsConnected

Gets or sets a value indicating whether a PipeStream object is connected.(Inherited from PipeStream.)

System_CAPS_pubpropertyIsMessageComplete

Gets a value indicating whether there is more data in the message returned from the most recent read operation.(Inherited from PipeStream.)

System_CAPS_pubpropertyLength

Gets the length of a stream, in bytes.(Inherited from PipeStream.)

System_CAPS_pubpropertyOutBufferSize

Gets the size, in bytes, of the outbound buffer for a pipe.(Inherited from PipeStream.)

System_CAPS_pubpropertyPosition

Gets or sets the current position of the current stream.(Inherited from PipeStream.)

System_CAPS_pubpropertyReadMode

Sets the reading mode for the AnonymousPipeClientStream object.(Overrides PipeStream.ReadMode.)

System_CAPS_pubpropertyReadTimeout

Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.)

System_CAPS_pubpropertySafePipeHandle

Gets the safe handle for the local end of the pipe that the current PipeStream object encapsulates.(Inherited from PipeStream.)

System_CAPS_pubpropertyTransmissionMode

Gets the pipe transmission mode supported by the current pipe.(Overrides PipeStream.TransmissionMode.)

System_CAPS_pubpropertyWriteTimeout

Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.)

NameDescription
System_CAPS_pubmethodBeginRead(Byte[], Int32, Int32, AsyncCallback, Object)

Begins an asynchronous read operation.(Inherited from PipeStream.)

System_CAPS_pubmethodBeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)

Begins an asynchronous write operation.(Inherited from PipeStream.)

System_CAPS_protmethodCheckPipePropertyOperations()

This API supports the product infrastructure and is not intended to be used directly from your code. Verifies that the pipe is in a proper state for getting or setting properties.(Inherited from PipeStream.)

System_CAPS_protmethodCheckReadOperations()

This API supports the product infrastructure and is not intended to be used directly from your code. Verifies that the pipe is in a connected state for read operations.(Inherited from PipeStream.)

System_CAPS_protmethodCheckWriteOperations()

This API supports the product infrastructure and is not intended to be used directly from your code. Verifies that the pipe is in a connected state for write operations.(Inherited from PipeStream.)

System_CAPS_pubmethodClose()

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.)

System_CAPS_pubmethodCopyTo(Stream)

Reads the bytes from the current stream and writes them to another stream.(Inherited from Stream.)

System_CAPS_pubmethodCopyTo(Stream, Int32)

Reads the bytes from the current stream and writes them to another stream, using a specified buffer size.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(Stream)

Asynchronously reads the bytes from the current stream and writes them to another stream.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(Stream, Int32)

Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(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.(Inherited from Stream.)

System_CAPS_pubmethodCreateObjRef(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.)

System_CAPS_pubmethodDispose()

Releases all resources used by the Stream.(Inherited from Stream.)

System_CAPS_pubmethodEndRead(IAsyncResult)

Ends a pending asynchronous read request.(Inherited from PipeStream.)

System_CAPS_pubmethodEndWrite(IAsyncResult)

Ends a pending asynchronous write request.(Inherited from PipeStream.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Releases unmanaged resources and performs other cleanup operations before the AnonymousPipeClientStream instance is reclaimed by garbage collection.(Overrides Object.Finalize().)

System_CAPS_pubmethodFlush()

Clears the buffer for the current stream and causes any buffered data to be written to the underlying device.(Inherited from PipeStream.)

System_CAPS_pubmethodFlushAsync()

Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.(Inherited from Stream.)

System_CAPS_pubmethodFlushAsync(CancellationToken)

Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.(Inherited from Stream.)

System_CAPS_pubmethodGetAccessControl()

Gets a PipeSecurity object that encapsulates the access control list (ACL) entries for the pipe described by the current PipeStream object.(Inherited from PipeStream.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodRead(Byte[], Int32, Int32)

Reads a block of bytes from a stream and writes the data to a specified buffer.(Inherited from PipeStream.)

System_CAPS_pubmethodReadAsync(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.)

System_CAPS_pubmethodReadAsync(Byte[], Int32, Int32, CancellationToken)

Asynchronously reads a sequence 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.)

System_CAPS_pubmethodReadByte()

Reads a byte from a pipe.(Inherited from PipeStream.)

System_CAPS_pubmethodSeek(Int64, SeekOrigin)

Sets the current position of the current stream to the specified value.(Inherited from PipeStream.)

System_CAPS_pubmethodSetAccessControl(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.)

System_CAPS_pubmethodSetLength(Int64)

Sets the length of the current stream to the specified value.(Inherited from PipeStream.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWaitForPipeDrain()

Waits for the other end of the pipe to read all sent bytes.(Inherited from PipeStream.)

System_CAPS_pubmethodWrite(Byte[], Int32, Int32)

Writes a block of bytes to the current stream using data from a buffer.(Inherited from PipeStream.)

System_CAPS_pubmethodWriteAsync(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.)

System_CAPS_pubmethodWriteAsync(Byte[], Int32, Int32, 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 Stream.)

System_CAPS_pubmethodWriteByte(Byte)

Writes a byte to the current stream.(Inherited from PipeStream.)

Anonymous pipes help provide safe and secure interprocess communication between child and parent processes. The AnonymousPipeClientStream class enables a child process to connect to and exchange information with a parent 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 Message read modes.

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 passed to the AnonymousPipeClientStream constructor as the pipeHandleAsString parameter.

System_CAPS_noteNote

For Windows XP Professional and Windows 2000 Server, a maximum of 10 pipes can simultaneously connect over the network.

The following example demonstrates a way to send a string from a parent process to a child process by using anonymous pipes. This example creates an AnonymousPipeServerStream object in a parent process with a PipeDirection value of Out. It also creates an AnonymousPipeClientStream object in a child process with a PipeDirection value of 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 client process, which is started by the server process. Name the resulting executable from the client code pipeClient.exe and copy it to the same directory as the server executable when you run this example. 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.

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]))
            {
                // Show that anonymous Pipes do not support Message mode.
                try
                {
                    Console.WriteLine("[CLIENT] Setting ReadMode to \"Message\".");
                    pipeClient.ReadMode = PipeTransmissionMode.Message;
                }
                catch (NotSupportedException e)
                {
                    Console.WriteLine("[CLIENT] Execption:\n    {0}", e.Message);
                }

                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();
    }
}

.NET Framework
Available since 3.5

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft