NetNamedPipeBinding Class

Definition

Namespace:

System.ServiceModel

Assembly:

System.ServiceModel.NetNamedPipe.dll

Package:

System.ServiceModel.NetNamedPipe v8.1.0

Source:

NetNamedPipeBinding.cs

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

public ref class NetNamedPipeBinding : System::ServiceModel::Channels::Binding

[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public class NetNamedPipeBinding : System.ServiceModel.Channels.Binding

[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]
type NetNamedPipeBinding = class
    inherit Binding

Public Class NetNamedPipeBinding
Inherits Binding

Inheritance

Object

Binding

NetNamedPipeBinding

Attributes

SupportedOSPlatformAttribute

Examples

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;

}
}

Remarks

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.

Constructors

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

Properties

CloseTimeout	Gets or sets the interval of time provided for a connection to close before the transport raises an exception. (Inherited from Binding)
EnvelopeVersion	Gets the version of SOAP that is used for messages processed by this binding.
MaxBufferPoolSize	Gets or sets the maximum number of bytes that are used to buffer incoming messages in memory.
MaxBufferSize	Gets or sets the maximum number of bytes used to buffer incoming messages in memory.
MaxConnections	Gets or sets the maximum number of connections, both inbound and outbound, that are allowed to endpoints configured with the named pipe binding.
MaxReceivedMessageSize	Gets or sets the maximum size, in bytes, for a received message that is processed by the binding.
MessageVersion	Gets the message version used by clients and services configured with the binding. (Inherited from Binding)
Name	Gets or sets the name of the binding. (Inherited from Binding)
Namespace	Gets or sets the XML namespace of the binding. (Inherited from Binding)
OpenTimeout	Gets or sets the interval of time provided for a connection to open before the transport raises an exception. (Inherited from Binding)
ReaderQuotas	Gets or sets constraints on the complexity of SOAP messages that can be processed by endpoints configured with this binding.
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)
Scheme	Gets the URI transport scheme for the channels and listeners that are configured with this binding.
Security	Gets an object that specifies the type of security used with services configured with this binding.
SendTimeout	Gets or sets the interval of time provided for a write operation to complete before the transport raises an exception. (Inherited from Binding)
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.

Methods

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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
CreateBindingElements()	Creates a collection with the binding elements for the binding.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetProperty<T>(BindingParameterCollection)	Returns a typed object requested, if present, from the appropriate layer in the binding stack. (Inherited from Binding)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ShouldSerializeName()	Returns whether the name of the binding should be serialized. (Inherited from Binding)
ShouldSerializeNamespace()	Returns whether the namespace of the binding should be serialized. (Inherited from Binding)
ToString()	Returns a string that represents the current object. (Inherited from Object)