2 out of 2 rated this helpful - Rate this topic

NetNamedPipeBinding Class

Provides a secure and reliable binding that is optimized for on-machine communication.

System.Object
  System.ServiceModel.Channels.Binding
    System.ServiceModel.NetNamedPipeBinding

Namespace:  System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
public class NetNamedPipeBinding : Binding, 
	IBindingRuntimePreferences

The NetNamedPipeBinding type exposes the following members.

  Name Description
Public method NetNamedPipeBinding() Initializes a new instance of the NetNamedPipeBinding class.
Public method NetNamedPipeBinding(NetNamedPipeSecurityMode) Initializes a new instance of the NetNamedPipeBinding class with a specified security mode.
Public method NetNamedPipeBinding(String) Initializes a new instance of the NetNamedPipeBinding class with a specified configuration name.
Top
  Name Description
Public property CloseTimeout Gets or sets the interval of time provided for a connection to close before the transport raises an exception. (Inherited from Binding.)
Public property EnvelopeVersion Gets the version of SOAP that is used for messages processed by this binding.
Public property HostNameComparisonMode Gets or sets a value that indicates whether the hostname is used to reach the service when matching the URI.
Public property MaxBufferPoolSize Gets or sets the maximum number of bytes that are used to buffer incoming messages in memory.
Public property MaxBufferSize Gets or sets the maximum number of bytes used to buffer incoming messages in memory.
Public property MaxConnections Gets or sets the maximum number of connections, both inbound and outbound, that are allowed to endpoints configured with the named pipe binding.
Public property MaxReceivedMessageSize Gets or sets the maximum size for a received message that is processed by the binding.
Public property MessageVersion Gets the message version used by clients and services configured with the binding. (Inherited from Binding.)
Public property Name Gets or sets the name of the binding. (Inherited from Binding.)
Public property Namespace Gets or sets the XML namespace of the binding. (Inherited from Binding.)
Public property OpenTimeout Gets or sets the interval of time provided for a connection to open before the transport raises an exception. (Inherited from Binding.)
Public property ReaderQuotas Gets or sets constraints on the complexity of SOAP messages that can be processed by endpoints configured with this binding.
Public property ReceiveTimeout Gets or sets the interval of time that a connection can remain inactive, during which no application messages are received, before it is dropped. (Inherited from Binding.)
Public property Scheme Gets the URI transport scheme for the channels and listeners that are configured with this binding. (Overrides Binding.Scheme.)
Public property Security Gets an object that specifies the type of security used with services configured with this binding.
Public property SendTimeout Gets or sets the interval of time provided for a write operation to complete before the transport raises an exception. (Inherited from Binding.)
Public property TransactionFlow Gets or sets a value that determines whether transactions should be flowed to the service.
Public property TransactionProtocol Gets or sets the transactions protocol used by the service to flow transactions.
Public property TransferMode Gets or sets a value that indicates whether the service configured with the binding uses streamed (in one or both directions) or buffered modes of message transfer.
Top
  Name Description
Public method BuildChannelFactory<TChannel>(BindingParameterCollection) Builds the channel factory stack on the client that creates a specified type of channel and that satisfies the features specified by a collection of binding parameters. (Inherited from Binding.)
Public method BuildChannelFactory<TChannel>(Object[]) Builds the channel factory stack on the client that creates a specified type of channel and that satisfies the features specified by an object array. (Inherited from Binding.)
Public method BuildChannelListener<TChannel>(BindingParameterCollection) Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified by a collection of binding parameters. (Inherited from Binding.)
Public method BuildChannelListener<TChannel>(Object[]) Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified. (Inherited from Binding.)
Public method BuildChannelListener<TChannel>(Uri, Object[]) Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified. (Inherited from Binding.)
Public method BuildChannelListener<TChannel>(Uri, BindingParameterCollection) Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified. (Inherited from Binding.)
Public method BuildChannelListener<TChannel>(Uri, String, Object[]) Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified. (Inherited from Binding.)
Public method BuildChannelListener<TChannel>(Uri, String, BindingParameterCollection) Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified. (Inherited from Binding.)
Public method BuildChannelListener<TChannel>(Uri, String, ListenUriMode, Object[]) Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified. (Inherited from Binding.)
Public method BuildChannelListener<TChannel>(Uri, String, ListenUriMode, BindingParameterCollection) Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified. (Inherited from Binding.)
Public method CanBuildChannelFactory<TChannel>(BindingParameterCollection) Returns a value that indicates whether the current binding can build a channel factory stack on the client that satisfies the collection of binding parameters specified. (Inherited from Binding.)
Public method CanBuildChannelFactory<TChannel>(Object[]) Returns a value that indicates whether the current binding can build a channel factory stack on the client that satisfies the requirements specified by an object array. (Inherited from Binding.)
Public method CanBuildChannelListener<TChannel>(BindingParameterCollection) Returns a value that indicates whether the current binding can build a channel listener stack on the service that satisfies the collection of binding parameters specified. (Inherited from Binding.)
Public method CanBuildChannelListener<TChannel>(Object[]) Returns a value that indicates whether the current binding can build a channel listener stack on the service that satisfies the criteria specified in an array of objects. (Inherited from Binding.)
Public method CreateBindingElements Creates a collection with the binding elements for the binding. (Overrides Binding.CreateBindingElements().)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetProperty<T> Returns a typed object requested, if present, from the appropriate layer in the binding stack. (Inherited from Binding.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ShouldSerializeName Returns whether the name of the binding should be serialized. (Inherited from Binding.)
Public method ShouldSerializeNamespace Returns whether the namespace of the binding should be serialized. (Inherited from Binding.)
Public method ShouldSerializeReaderQuotas Returns a value that indicates whether the ReaderQuotas property has changed from its default value and should be serialized. This is used by for XAML integration.
Public method ShouldSerializeSecurity Returns a value that indicates whether the Security property has changed from its default value and should be serialized. This is used by for XAML integration.
Public method ShouldSerializeTransactionProtocol Returns a value that indicates whether the TransactionProtocol property has changed from its default value and should be serialized. This is used by for XAML integration.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private property IBindingRuntimePreferences.ReceiveSynchronously Gets a value that indicates whether incoming requests are handled synchronously or asynchronously.
Top

The NetNamedPipeBinding generates a run-time communication stack by default, which uses transport security, named pipes for message delivery, and a binary message encoding. This binding is an appropriate system-provided choice for on-machine communication. It also supports transactions.

The default configuration for the NetNamedPipeBinding is similar to the configuration provided by the NetTcpBinding, but it is simpler because the implementation is only meant for on-machine use and consequently there are fewer exposed features. The most notable difference is that the SecurityMode setting only offers the None and Transport options. SOAP security support is not an included option. The security behavior is configurable using the optional securityMode parameter in NetNamedPipeBinding(NetNamedPipeSecurityMode) the constructor.

The following example shows the part of the configuration file that contains the section for the NetNamedPipeBinding with values set to defaults.


<bindings>
  <!-- 
        Following is the expanded configuration section for a NetNamedPipeBinding.
        Each property is configured with the default value.
     -->
  <netNamedPipeBinding>
    <binding name="Binding1" 
             hostNameComparisonMode="StrongWildcard" 
             maxBufferSize="65536"
             maxConnections="10"
             maxReceivedMessageSize="65536"
             receiveTimeout="00:10:00"
             transactionFlow="false">
      <security mode="Transport">
      </security>
    </binding>
  </netNamedPipeBinding>
</bindings>


The following example shows how to programmatically use the NetNamedPipeBinding class.


    [ServiceContract(Namespace = "http://UE.Samples")]
    public interface ICalculator
    {
        [OperationContract]
        double Add(double n1, double n2);
    }

    // Service class which implements the service contract.
    public class CalculatorService : ICalculator
    {
        public double Add(double n1, double n2)
        {
            return n1 + n2;
        }

        public static void Main()
        {
            Uri baseAddress = new Uri("http://localhost:8000/uesamples/service");
            string address = "net.pipe://localhost/uesamples/calc";

            // Create a ServiceHost for the CalculatorService type and provide the base address.
            using (ServiceHost serviceHost = new ServiceHost(typeof(CalculatorService), baseAddress))
            {
                NetNamedPipeBinding binding = new NetNamedPipeBinding(NetNamedPipeSecurityMode.None);
                serviceHost.AddServiceEndpoint(typeof(ICalculator), binding, address);

                // Add a mex endpoint
                ServiceMetadataBehavior smb = new ServiceMetadataBehavior();
                smb.HttpGetEnabled = true;
                smb.HttpGetUrl = new Uri("http://localhost:8001/uesamples");
                serviceHost.Description.Behaviors.Add(smb);

		long maxBufferPoolSize = binding.MaxBufferPoolSize;

		int maxBufferSize = binding.MaxBufferSize;

		int maxConnections = binding.MaxConnections;

		long maxReceivedMessageSize =
		    binding.MaxReceivedMessageSize;

		NetNamedPipeSecurity security = binding.Security;

		string scheme = binding.Scheme;

		XmlDictionaryReaderQuotas readerQuotas =
			binding.ReaderQuotas;

		BindingElementCollection bCollection = binding.CreateBindingElements();

		HostNameComparisonMode hostNameComparisonMode =
			binding.HostNameComparisonMode;

		bool TransactionFlow = binding.TransactionFlow;

		TransactionProtocol transactionProtocol =
			binding.TransactionProtocol;

		EnvelopeVersion envelopeVersion =
			binding.EnvelopeVersion;

		TransferMode transferMode =
			binding.TransferMode;


				
                serviceHost.Open();

                Console.WriteLine("The service is ready.");
                Console.WriteLine("Press <ENTER> to terminate service.");
                Console.WriteLine();
                Console.ReadLine();

                serviceHost.Close();
            }
        }

	static void SnippetReceiveSynchronously ()
	{

		NetNamedPipeBinding binding = new NetNamedPipeBinding();
		IBindingRuntimePreferences s  =
		       binding.GetProperty<IBindingRuntimePreferences>
		       (new BindingParameterCollection());
		bool receiveSynchronously = s.ReceiveSynchronously;


	}
    }


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Internal size limit
"When using WCF named pipes as an interprocess communications mechanism: they have by default an array size limit of 16384 buried deep down in XmlReaderDictionaryQuotas of the NetNamedPipeBinding, which causes all sorts of hilarity when you have an a byte array of 20kB." - OzPeter

source: http://forums.thedailywtf.com/forums/t/20246.aspx