NetNamedPipeBinding Class
TOC
Collapse the table of content
Expand the table of content

NetNamedPipeBinding Class

 

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

Namespace:   System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

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

public class NetNamedPipeBinding : Binding, IBindingRuntimePreferences

NameDescription
System_CAPS_pubmethodNetNamedPipeBinding()

Initializes a new instance of the NetNamedPipeBinding class.

System_CAPS_pubmethodNetNamedPipeBinding(NetNamedPipeSecurityMode)

Initializes a new instance of the NetNamedPipeBinding class with a specified security mode.

System_CAPS_pubmethodNetNamedPipeBinding(String)

Initializes a new instance of the NetNamedPipeBinding class with a specified configuration name.

NameDescription
System_CAPS_pubpropertyCloseTimeout

Gets or sets the interval of time provided for a connection to close before the transport raises an exception.(Inherited from Binding.)

System_CAPS_pubpropertyEnvelopeVersion

Gets the version of SOAP that is used for messages processed by this binding.

System_CAPS_pubpropertyHostNameComparisonMode

Gets or sets a value that indicates whether the hostname is used to reach the service when matching the URI.

System_CAPS_pubpropertyMaxBufferPoolSize

Gets or sets the maximum number of bytes that are used to buffer incoming messages in memory.

System_CAPS_pubpropertyMaxBufferSize

Gets or sets the maximum number of bytes used to buffer incoming messages in memory.

System_CAPS_pubpropertyMaxConnections

Gets or sets the maximum number of connections, both inbound and outbound, that are allowed to endpoints configured with the named pipe binding.

System_CAPS_pubpropertyMaxReceivedMessageSize

Gets or sets the maximum size, in bytes, for a received message that is processed by the binding.

System_CAPS_pubpropertyMessageVersion

Gets the message version used by clients and services configured with the binding.(Inherited from Binding.)

System_CAPS_pubpropertyName

Gets or sets the name of the binding.(Inherited from Binding.)

System_CAPS_pubpropertyNamespace

Gets or sets the XML namespace of the binding.(Inherited from Binding.)

System_CAPS_pubpropertyOpenTimeout

Gets or sets the interval of time provided for a connection to open before the transport raises an exception.(Inherited from Binding.)

System_CAPS_pubpropertyReaderQuotas

Gets or sets constraints on the complexity of SOAP messages that can be processed by endpoints configured with this binding.

System_CAPS_pubpropertyReceiveTimeout

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

System_CAPS_pubpropertyScheme

Gets the URI transport scheme for the channels and listeners that are configured with this binding.(Overrides Binding.Scheme.)

System_CAPS_pubpropertySecurity

Gets an object that specifies the type of security used with services configured with this binding.

System_CAPS_pubpropertySendTimeout

Gets or sets the interval of time provided for a write operation to complete before the transport raises an exception.(Inherited from Binding.)

System_CAPS_pubpropertyTransactionFlow

Gets or sets a value that determines whether transactions should be flowed to the service.

System_CAPS_pubpropertyTransactionProtocol

Gets or sets the transactions protocol used by the service to flow transactions.

System_CAPS_pubpropertyTransferMode

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

System_CAPS_pubmethodCreateBindingElements()

Creates a collection with the binding elements for the binding.(Overrides Binding.CreateBindingElements().)

System_CAPS_pubmethodEquals(Object)

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

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

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

System_CAPS_pubmethodGetProperty<T>(BindingParameterCollection)

Returns a typed object requested, if present, from the appropriate layer in the binding stack.(Inherited from Binding.)

System_CAPS_pubmethodGetType()

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

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodShouldSerializeMaxConnections()

Returns a value that indicates whether the MaxConnections property has changed from its default value and should be serialized.

System_CAPS_pubmethodShouldSerializeName()

Returns whether the name of the binding should be serialized.(Inherited from Binding.)

System_CAPS_pubmethodShouldSerializeNamespace()

Returns whether the namespace of the binding should be serialized.(Inherited from Binding.)

System_CAPS_pubmethodShouldSerializeReaderQuotas()

Returns a value that indicates whether the ReaderQuotas property has changed from its default value and should be serialized. This is used by WCF for XAML integration.

System_CAPS_pubmethodShouldSerializeSecurity()

Returns a value that indicates whether the Security property has changed from its default value and should be serialized. This is used by WCF for XAML integration.

System_CAPS_pubmethodShouldSerializeTransactionProtocol()

Returns a value that indicates whether the TransactionProtocol property has changed from its default value and should be serialized. This is used by WCF for XAML integration.

System_CAPS_pubmethodToString()

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

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privpropertyIBindingRuntimePreferences.ReceiveSynchronously

Gets a value that indicates whether incoming requests are handled synchronously or asynchronously.

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 Windows Communication Foundation (WCF) 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 WCF 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.

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
Available since 3.0

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