Edit

Share via


NamedPipeTransportBindingElement Class

Definition

Represents the binding element for the named pipe transport.

public ref class NamedPipeTransportBindingElement : System::ServiceModel::Channels::ConnectionOrientedTransportBindingElement
[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public class NamedPipeTransportBindingElement : System.ServiceModel.Channels.ConnectionOrientedTransportBindingElement
public class NamedPipeTransportBindingElement : System.ServiceModel.Channels.ConnectionOrientedTransportBindingElement
[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]
type NamedPipeTransportBindingElement = class
    inherit ConnectionOrientedTransportBindingElement
type NamedPipeTransportBindingElement = class
    inherit ConnectionOrientedTransportBindingElement
Public Class NamedPipeTransportBindingElement
Inherits ConnectionOrientedTransportBindingElement
Inheritance
Attributes

Examples

This example shows how to use this class:

NamedPipeTransportBindingElement bElement =
    new NamedPipeTransportBindingElement();

NamedPipeConnectionPoolSettings connectionPoolSettings =
    bElement.ConnectionPoolSettings;
Dim bElement As New NamedPipeTransportBindingElement()

Dim connectionPoolSettings As NamedPipeConnectionPoolSettings = bElement.ConnectionPoolSettings

Remarks

This transport uses URIs of the form "net.pipe://hostname/path". Other URI components are optional.

The NamedPipeTransportBindingElement class is the starting point for creating a custom binding that implements the named pipes transport protocol. This transport is used for on-machine WCF communication.

The WCF service model uses this class to create factory objects that implement the IChannelFactory and IChannelListener interfaces. These factory objects then create and accept the channels that transmit SOAP messages using the named pipes protocol.

You configure the factories that this class creates by setting its properties, such as: ConnectionPoolSettings.

You can also set properties on the base class, ConnectionOrientedTransportBindingElement, such as: MaxBufferSize, TransferMode, and ConnectionBufferSize. For a complete list of properties, see ConnectionOrientedTransportBindingElement.

Finally, you can set properties on the base class of ConnectionOrientedTransportBindingElement, which is TransportBindingElement, such as MaxBufferPoolSize. For a complete list of properties, see TransportBindingElement.

Constructors

NamedPipeTransportBindingElement()

Initializes a new instance of the NamedPipeTransportBindingElement class.

NamedPipeTransportBindingElement(NamedPipeTransportBindingElement)

Initializes a new instance of the NamedPipeTransportBindingElement class.

Properties

AllowedSecurityIdentifiers

Gets a collection of allowed SecurityIdentifier instances.

ChannelInitializationTimeout

Gets or sets a TimeSpan that determines the maximum time a channel can be in the initialization status before being disconnected.

(Inherited from ConnectionOrientedTransportBindingElement)
ConnectionBufferSize

Gets or sets the size of the buffer used to transmit a chunk of the serialized message on the wire from the client or service.

(Inherited from ConnectionOrientedTransportBindingElement)
ConnectionPoolSettings

Gets a collection of connection pool settings.

HostNameComparisonMode

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

(Inherited from ConnectionOrientedTransportBindingElement)
ManualAddressing

Gets or sets a value that indicates whether manual addressing of the message is required.

(Inherited from TransportBindingElement)
MaxBufferPoolSize

Gets or sets the maximum size, in bytes, of any buffer pools used by the transport.

(Inherited from TransportBindingElement)
MaxBufferSize

Gets or sets the maximum size of the buffer to use. For streamed messages, this value should be at least the maximum possible size of the message headers, which are read in buffered mode.

(Inherited from ConnectionOrientedTransportBindingElement)
MaxOutputDelay

Gets or sets the maximum interval of time that a chunk of a message or a full message can remain buffered in memory before being sent out.

(Inherited from ConnectionOrientedTransportBindingElement)
MaxPendingAccepts

Gets or sets the maximum number of channels a service can have waiting on a listener for processing incoming connections to the service.

(Inherited from ConnectionOrientedTransportBindingElement)
MaxPendingConnections

Gets or sets the maximum number of connections awaiting dispatch on the service.

(Inherited from ConnectionOrientedTransportBindingElement)
MaxReceivedMessageSize

Gets or sets the maximum allowable message size, in bytes, that can be received.

(Inherited from TransportBindingElement)
PipeSettings

Gets the pipe settings for the named pipe transport binding element.

Scheme

Returns the URI scheme for the transport.

TransferMode

Gets or sets a value that indicates whether the messages are buffered or streamed with the connection-oriented transport.

(Inherited from ConnectionOrientedTransportBindingElement)

Methods

BuildChannelFactory<TChannel>(BindingContext)

Creates a channel factory of the specified type that can be used to create channels.

BuildChannelListener<TChannel>(BindingContext)

Creates a channel listener of the specified type.

BuildChannelListener<TChannel>(BindingContext)

Initializes a channel listener to accept channels of a specified type from the binding context.

(Inherited from BindingElement)
CanBuildChannelFactory<TChannel>(BindingContext)

Determines whether a channel factory of the specified type can be built.

(Inherited from ConnectionOrientedTransportBindingElement)
CanBuildChannelListener<TChannel>(BindingContext)

Determines whether a channel listener of the specified type can be built.

(Inherited from ConnectionOrientedTransportBindingElement)
Clone()

Creates a copy of the current binding element.

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>(BindingContext)

Gets a specified object from the BindingContext.

GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ShouldSerializeMaxPendingAccepts()

Indicates whether the connection oriented transport binding element should serialize maximum pending accepts.

(Inherited from ConnectionOrientedTransportBindingElement)
ShouldSerializeMaxPendingConnections()

Indicates whether the connection oriented transport binding element should serialize maximum pending connections.

(Inherited from ConnectionOrientedTransportBindingElement)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

IPolicyExportExtension.ExportPolicy(MetadataExporter, PolicyConversionContext)

Exports a custom policy assertion about bindings.

(Inherited from ConnectionOrientedTransportBindingElement)
IWsdlExportExtension.ExportContract(WsdlExporter, WsdlContractConversionContext)

Writes custom Web Services Description Language (WSDL) elements into the generated WSDL for a contract.

(Inherited from ConnectionOrientedTransportBindingElement)
IWsdlExportExtension.ExportEndpoint(WsdlExporter, WsdlEndpointConversionContext)

Writes custom Web Services Description Language (WSDL) elements into the generated WSDL for an endpoint.

(Inherited from ConnectionOrientedTransportBindingElement)

Applies to