Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

NamedPipeServerStream Class

Exposes a Stream around a named pipe, supporting both synchronous and asynchronous read and write operations.

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

Namespace:  System.IO.Pipes
Assembly:  System.Core (in System.Core.dll)
[HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort = true)]
public sealed class NamedPipeServerStream : PipeStream

The NamedPipeServerStream type exposes the following members.

  NameDescription
Public methodNamedPipeServerStream(String)Initializes a new instance of the NamedPipeServerStream class with the specified pipe name.
Public methodNamedPipeServerStream(String, PipeDirection)Initializes a new instance of the NamedPipeServerStream class with the specified pipe name and pipe direction.
Public methodNamedPipeServerStream(String, PipeDirection, Int32)Initializes a new instance of the NamedPipeServerStream class with the specified pipe name, pipe direction, and maximum number of server instances.
Public methodNamedPipeServerStream(PipeDirection, Boolean, Boolean, SafePipeHandle)Initializes a new instance of the NamedPipeServerStream class from the specified pipe handle.
Public methodNamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode)Initializes a new instance of the NamedPipeServerStream class with the specified pipe name, pipe direction, maximum number of server instances, and transmission mode.
Public methodNamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode, PipeOptions)Initializes a new instance of the NamedPipeServerStream class with the specified pipe name, pipe direction, maximum number of server instances, transmission mode, and pipe options.
Public methodNamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode, PipeOptions, Int32, Int32)Initializes a new instance of the NamedPipeServerStream class with the specified pipe name, pipe direction, maximum number of server instances, transmission mode, pipe options, and recommended in and out buffer sizes.
Public methodNamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode, PipeOptions, Int32, Int32, PipeSecurity)Initializes a new instance of the NamedPipeServerStream class with the specified pipe name, pipe direction, maximum number of server instances, transmission mode, pipe options, recommended in and out buffer sizes, and pipe security.
Public methodNamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode, PipeOptions, Int32, Int32, PipeSecurity, HandleInheritability)Initializes a new instance of the NamedPipeServerStream class with the specified pipe name, pipe direction, maximum number of server instances, transmission mode, pipe options, recommended in and out buffer sizes, pipe security, and inheritability mode.
Public methodNamedPipeServerStream(String, PipeDirection, Int32, PipeTransmissionMode, PipeOptions, Int32, Int32, PipeSecurity, HandleInheritability, PipeAccessRights)Initializes a new instance of the NamedPipeServerStream class with the specified pipe name, pipe direction, maximum number of server instances, transmission mode, pipe options, recommended in and out buffer sizes, pipe security, inheritability mode, and pipe access rights.
Top
  NameDescription
Public propertyCanReadGets a value indicating whether the current stream supports read operations. (Inherited from PipeStream.)
Public propertyCanSeekGets a value indicating whether the current stream supports seek operations. (Inherited from PipeStream.)
Public propertyCanTimeoutGets a value that determines whether the current stream can time out. (Inherited from Stream.)
Public propertyCanWriteGets a value indicating whether the current stream supports write operations. (Inherited from PipeStream.)
Public propertyInBufferSizeGets the size, in bytes, of the inbound buffer for a pipe. (Inherited from PipeStream.)
Public propertyIsAsyncGets a value indicating whether a PipeStream object was opened asynchronously or synchronously. (Inherited from PipeStream.)
Public propertyIsConnectedGets or sets a value indicating whether a PipeStream object is connected. (Inherited from PipeStream.)
Public propertyIsMessageCompleteGets a value indicating whether there is more data in the message returned from the most recent read operation. (Inherited from PipeStream.)
Public propertyLengthGets the length of a stream, in bytes. (Inherited from PipeStream.)
Public propertyOutBufferSizeGets the size, in bytes, of the outbound buffer for a pipe. (Inherited from PipeStream.)
Public propertyPositionGets or sets the current position of the current stream. (Inherited from PipeStream.)
Public propertyReadModeGets or sets the reading mode for a PipeStream object. (Inherited from PipeStream.)
Public propertyReadTimeoutGets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.)
Public propertySafePipeHandleGets the safe handle for the local end of the pipe that the current PipeStream object encapsulates. (Inherited from PipeStream.)
Public propertyTransmissionModeGets the pipe transmission mode supported by the current pipe. (Inherited from PipeStream.)
Public propertyWriteTimeoutGets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.)
Top
  NameDescription
Public methodBeginReadBegins an asynchronous read operation. (Inherited from PipeStream.)
Public methodBeginWaitForConnectionBegins an asynchronous operation to wait for a client to connect.
Public methodBeginWriteBegins an asynchronous write operation. (Inherited from PipeStream.)
Protected methodCheckPipePropertyOperationsInfrastructure. Verifies that the pipe is in a proper state for getting or setting properties. (Inherited from PipeStream.)
Protected methodCheckReadOperationsInfrastructure. Verifies that the pipe is in a connected state for read operations. (Inherited from PipeStream.)
Protected methodCheckWriteOperationsInfrastructure. Verifies that the pipe is in a connected state for write operations. (Inherited from PipeStream.)
Public methodCloseCloses 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.)
Public methodCopyTo(Stream)Reads the bytes from the current stream and writes them to another stream. (Inherited from Stream.)
Public methodCopyTo(Stream, Int32)Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream.)
Public methodCopyToAsync(Stream)Asynchronously reads the bytes from the current stream and writes them to another stream. (Inherited from Stream.)
Public methodCopyToAsync(Stream, Int32)Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream.)
Public methodCopyToAsync(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.)
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodDisconnectDisconnects the current connection.
Public methodDispose()Releases all resources used by the Stream. (Inherited from Stream.)
Public methodEndReadEnds a pending asynchronous read request. (Inherited from PipeStream.)
Public methodEndWaitForConnectionEnds an asynchronous operation to wait for a client to connect.
Public methodEndWriteEnds a pending asynchronous write request. (Inherited from PipeStream.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodFlushClears the buffer for the current stream and causes any buffered data to be written to the underlying device. (Inherited from PipeStream.)
Public methodFlushAsync()Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Inherited from Stream.)
Public methodFlushAsync(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.)
Public methodGetAccessControlGets a PipeSecurity object that encapsulates the access control list (ACL) entries for the pipe described by the current PipeStream object. (Inherited from PipeStream.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetImpersonationUserNameGets the user name of the client on the other end of the pipe.
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodReadReads a block of bytes from a stream and writes the data to a specified buffer. (Inherited from PipeStream.)
Public methodReadAsync(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.)
Public methodReadAsync(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.)
Public methodReadByteReads a byte from a pipe. (Inherited from PipeStream.)
Public methodRunAsClientCalls a delegate while impersonating the client.
Public methodSeekSets the current position of the current stream to the specified value. (Inherited from PipeStream.)
Public methodSetAccessControlApplies the access control list (ACL) entries specified by a PipeSecurity object to the pipe specified by the current PipeStream object. (Inherited from PipeStream.)
Public methodSetLengthSets the length of the current stream to the specified value. (Inherited from PipeStream.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWaitForConnectionWaits for a client to connect to this NamedPipeServerStream object.
Public methodWaitForPipeDrainWaits for the other end of the pipe to read all sent bytes. (Inherited from PipeStream.)
Public methodWriteWrites a block of bytes to the current stream using data from a buffer. (Inherited from PipeStream.)
Public methodWriteAsync(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.)
Public methodWriteAsync(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.)
Public methodWriteByteWrites a byte to the current stream. (Inherited from PipeStream.)
Top
  NameDescription
Public fieldStatic memberMaxAllowedServerInstancesRepresents the maximum number of server instances that the system resources allow.
Top

Named pipes provide one-way or duplex pipes for communication between a pipe server and one or more pipe clients. Named pipes can be used for interprocess communication locally or over a network. A single pipe name can be shared by multiple NamedPipeClientStream objects.

Any process can act as either a named pipe server or client, or both.

NoteNote

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

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

The following example demonstrates a way to send a string from a parent process to a child process on the same computer using named pipes. This example creates a NamedPipeServerStream object in a parent process with a PipeDirection value of Out. The server then waits for a NamedPipeClientStream object in a child process to connect to it. In this example, both processes are on the same computer and the NamedPipeClientStream object has 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 server process, which uses the NamedPipeServerStream class. For the entire code example, including the code for both the pipe client and server, see How to: Use Named Pipes for Network Interprocess Communication.

using System;
using System.IO;
using System.IO.Pipes;

class PipeServer
{
    static void Main()
    {
        using (NamedPipeServerStream pipeServer =
            new NamedPipeServerStream("testpipe", PipeDirection.Out))
        {
            Console.WriteLine("NamedPipeServerStream object created.");

            // Wait for a client to connect
            Console.Write("Waiting for client connection...");
            pipeServer.WaitForConnection();

            Console.WriteLine("Client connected.");
            try
            {
                // Read user input and send that to the client process. 
                using (StreamWriter sw = new StreamWriter(pipeServer))
                {
                    sw.AutoFlush = true;
                    Console.Write("Enter text: ");
                    sw.WriteLine(Console.ReadLine());
                }
            }
            // Catch the IOException that is raised if the pipe is broken 
            // or disconnected. 
            catch (IOException e)
            {
                Console.WriteLine("ERROR: {0}", e.Message);
            }
        }
    }
}

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft. All rights reserved.