This documentation is archived and is not being maintained.

OptionalReliableSession Class

Provides convenient access to whether a reliable session is enabled when using one of the predefined bindings where it is optional.


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

public class OptionalReliableSession : ReliableSession

The OptionalReliableSession type exposes the following members.

Public methodOptionalReliableSession()Initializes a new instance of the OptionalReliableSession class.
Public methodOptionalReliableSession(ReliableSessionBindingElement)Initializes a new instance of the OptionalReliableSession class from a reliable session binding element.

Public propertyEnabledGets or sets a value that indicates whether the reliable session is enabled.
Public propertyInactivityTimeoutGets or sets an interval of time that a service can remain inactive before closing. (Inherited from ReliableSession.)
Public propertyOrderedGets or sets a value that indicates whether message delivery must preserve the order in which messages are sent. (Inherited from ReliableSession.)

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The ability to enable a reliable session is provided with three of the system-provided bindings. A reliable session is:

  • Optional (and off by default) with NetTcpBinding and WsHttpBinding and

  • Required (and hence always on) with WsDualHttpBinding.

The following example shows how to create a new reliable session, access and change the default values of that session.

private void Run()
    WSHttpBinding b = new WSHttpBinding();
    b.Name = "HttpOrderedReliableSessionBinding";

    // Get a reference to the OptionalreliableSession object of the 
    // binding and set its properties to new values.
    OptionalReliableSession myReliableSession = b.ReliableSession;
    myReliableSession.Enabled = true; // The default is false.
    myReliableSession.Ordered = false; // The default is true. 
    myReliableSession.InactivityTimeout = 
        new TimeSpan(0, 15, 0); // The default is 10 minutes.
    // Create a URI for the service's base address.
    Uri baseAddress = new Uri("http://localhost:8008/Calculator");

    // Create a service host.
    ServiceHost sh = new ServiceHost(typeof(Calculator), baseAddress);

    // Optional: Print out the binding information. 
    // Create a URI for an endpoint, then add a service endpoint using the
    // binding with the latered OptionalReliableSession settings.
    sh.AddServiceEndpoint(typeof(ICalculator), b, "ReliableCalculator");



private void PrintBindingInfo(WSHttpBinding b)
    Console.WriteLine("Enabled: {0}", b.ReliableSession.Enabled);
    Console.WriteLine("Ordered: {0}", b.ReliableSession.Ordered);
    Console.WriteLine("Inactivity in Minutes: {0}",

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.