ReliableSessionBindingElement Class

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.0.0

Source:

ReliableSessionBindingElement.cs

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

public ref class ReliableSessionBindingElement sealed : System::ServiceModel::Channels::BindingElement

public sealed class ReliableSessionBindingElement : System.ServiceModel.Channels.BindingElement

type ReliableSessionBindingElement = class
    inherit BindingElement

Public NotInheritable Class ReliableSessionBindingElement
Inherits BindingElement

Inheritance

Object

BindingElement

ReliableSessionBindingElement

Examples

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();
}

Dim baseAddress As New Uri("http://localhost:8000/servicemodelsamples/service")

' Create a ServiceHost for the CalculatorService type and provide the base address.
Using serviceHost As New ServiceHost(GetType(CalculatorService), baseAddress)
    ' Create a custom binding that contains two binding elements.
    Dim reliableSession As New ReliableSessionBindingElement()
    reliableSession.Ordered = True

    Dim httpTransport As New HttpTransportBindingElement()
    httpTransport.AuthenticationScheme = System.Net.AuthenticationSchemes.Anonymous
    httpTransport.HostNameComparisonMode = HostNameComparisonMode.StrongWildcard

    Dim binding As New CustomBinding(reliableSession, httpTransport)

    ' Add an endpoint using that binding.
    serviceHost.AddServiceEndpoint(GetType(ICalculator), binding, "")

    ' Add a MEX endpoint.
    Dim smb As 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()
End Using

Remarks

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)

Constructors

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

Properties

AcknowledgementInterval	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.
FlowControlEnabled	Gets or sets a value that indicates whether the reliable session has flow control enabled.
InactivityTimeout	Gets or sets an interval of time that a service remains inactive before closing.
MaxPendingChannels	Gets or sets the largest number of channels that can be pending during the reliable session.
MaxRetryCount	Gets or sets the maximum number of times that a message attempts to be transferred during the reliable session.
MaxTransferWindowSize	Gets or sets the largest number of messages that can exist in either the send buffer or the receive buffer.
Ordered	Gets or sets a value that indicates whether message delivery must preserve the order in which messages are sent.
ReliableMessagingVersion	Gets or sets the version of WS-ReliableMessaging specified by the binding element.

Methods

BuildChannelFactory<TChannel>(BindingContext)	Returns a factory that creates a channel of a specified type that supports a reliable session.
BuildChannelListener<TChannel>(BindingContext)	Initializes a channel listener to accept channels of a specified type from the binding context. (Inherited from BindingElement)
CanBuildChannelFactory<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.
CanBuildChannelListener<TChannel>(BindingContext)	Returns a value that indicates whether the binding element can build a listener for a specific type of channel. (Inherited from BindingElement)
Clone()	Creates a copy of the current reliable session 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 property of the specified type from its binding context.
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)