ReliableSessionBindingElement Class

 

Represents the binding element that can produce the sending and receiving channels required for a reliable session between endpoints.

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

System.Object
  System.ServiceModel.Channels.BindingElement
    System.ServiceModel.Channels.ReliableSessionBindingElement

public sealed class ReliableSessionBindingElement : BindingElement, 
	IPolicyExportExtension

NameDescription
System_CAPS_pubmethodReliableSessionBindingElement()

Initializes a new instance of the ReliableSessionBindingElement class.

System_CAPS_pubmethodReliableSessionBindingElement(Boolean)

Initializes a new instance of the ReliableSessionBindingElement class that specifies whether message delivery must preserve the order in which messages are sent.

NameDescription
System_CAPS_pubpropertyAcknowledgementInterval

Gets or sets the interval of time that a destination waits before sending an acknowledgment to the message source on reliable channels that are created by the factory.

System_CAPS_pubpropertyFlowControlEnabled

Gets or sets a value that indicates whether the reliable session has flow control enabled.

System_CAPS_pubpropertyInactivityTimeout

Gets or sets an interval of time that a service remains inactive before closing.

System_CAPS_pubpropertyMaxPendingChannels

Gets or sets the largest number of channels that can be pending during the reliable session.

System_CAPS_pubpropertyMaxRetryCount

Gets or sets the maximum number of times that a message attempts to be transferred during the reliable session.

System_CAPS_pubpropertyMaxTransferWindowSize

Gets or sets the largest number of messages that can exist in either the send buffer or the receive buffer.

System_CAPS_pubpropertyOrdered

Gets or sets a value that indicates whether message delivery must preserve the order in which messages are sent.

System_CAPS_pubpropertyReliableMessagingVersion

Gets or sets the version of WS-ReliableMessaging specified by the binding element.

NameDescription
System_CAPS_pubmethodBuildChannelFactory<TChannel>(BindingContext)

Returns a factory that creates a channel of a specified type that supports a reliable session.(Overrides BindingElement.BuildChannelFactory<TChannel>(BindingContext).)

System_CAPS_pubmethodBuildChannelListener<TChannel>(BindingContext)

Returns a listener that accepts a channel of a specified type that supports a reliable session.(Overrides BindingElement.BuildChannelListener<TChannel>(BindingContext).)

System_CAPS_pubmethodCanBuildChannelFactory<TChannel>(BindingContext)

Returns a value that indicates whether the channel factory can be built for the channel and context provided that can support a reliable session.(Overrides BindingElement.CanBuildChannelFactory<TChannel>(BindingContext).)

System_CAPS_pubmethodCanBuildChannelListener<TChannel>(BindingContext)

Returns a value that indicates whether the channel listener can be built for the channel and context provided that can support a reliable session.(Overrides BindingElement.CanBuildChannelListener<TChannel>(BindingContext).)

System_CAPS_pubmethodClone()

Creates a copy of the current reliable session binding element.(Overrides BindingElement.Clone().)

System_CAPS_pubmethodEquals(Object)

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

System_CAPS_pubmethodGetHashCode()

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

System_CAPS_pubmethodGetProperty<T>(BindingContext)

Gets a property of the specified type from its binding context.(Overrides BindingElement.GetProperty<T>(BindingContext).)

System_CAPS_pubmethodGetType()

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

System_CAPS_pubmethodToString()

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

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIPolicyExportExtension.ExportPolicy(MetadataExporter, PolicyConversionContext)

Maps the information contained in the reliable session binding element into the WSDL elements that enable a remote endpoint to access the service with a reliable session.

Provides sessions and optionally provides ordered message delivery. This implemented session can cross SOAP and transport intermediaries.

Each binding element represents a processing step when sending or receiving messages. At runtime, binding elements create the channel factories and listeners that are necessary to build outgoing and incoming channel stacks required to send and receive messages. The ReliableSessionBindingElement provides an optional layer in the stack that can establish a reliable session between endpoints and configure the behavior of this session.

The ReliableSessionBindingElement is provided on the standard bindings in the following table.

Binding

Default

NetTcpBinding

Off

WSHttpBinding

Off

WSDualHttpBinding

On (required)

The ReliableSessionBindingElement can be added to any custom binding. This is done using the following configuration elements.

<bindings>
    <customBinding>
        <binding configurationName=”ReliabilityHTTP”>
            <reliableSession/>
        </binding>
    </customBinding>
</bindings>

The following sample code demonstrates how to use ReliableSessionBindingElement in code.

Uri baseAddress = new Uri("http://localhost:8000/servicemodelsamples/service");

// Create a ServiceHost for the CalculatorService type and provide the base address.
using (ServiceHost serviceHost = new ServiceHost(typeof(CalculatorService), baseAddress))
{
    // Create a custom binding that contains two binding elements.
    ReliableSessionBindingElement reliableSession = new ReliableSessionBindingElement();
    reliableSession.Ordered = true;

    HttpTransportBindingElement httpTransport = new HttpTransportBindingElement();
    httpTransport.AuthenticationScheme = System.Net.AuthenticationSchemes.Anonymous;
    httpTransport.HostNameComparisonMode = HostNameComparisonMode.StrongWildcard;

    CustomBinding binding = new CustomBinding(reliableSession, httpTransport);

    // Add an endpoint using that binding.
    serviceHost.AddServiceEndpoint(typeof(ICalculator), binding, "");

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

    // Open the ServiceHostBase to create listeners and start listening for messages.
    serviceHost.Open();

    // The service can now be accessed.
    Console.WriteLine("The service is ready.");
    Console.WriteLine("Press <ENTER> to terminate service.");
    Console.WriteLine();
    Console.ReadLine();

    // Close the ServiceHostBase to shutdown the service.
    serviceHost.Close();
}

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