• Article

ChannelFactoryBase<TChannel>.OnClose Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Closes all the channels associated with the channel factory within a specified interval of time.

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

Syntax

'Declaration
Protected Overrides Sub OnClose ( _
    timeout As TimeSpan _
)

protected override void OnClose(
    TimeSpan timeout
)

Parameters

  • timeout
    Type: System.TimeSpan
    The Timespan that specifies how long the on-close operation has to complete before timing out.

Remarks

This method sequentially attempts to close all of the active channels associated with the channel factory in no particular order. The timeout parameter is the cumulative amount of time available for closing all of the channels. If a graceful close of one of the channels fails (for example, if the channel is faulted causing an exception to be thrown) then this operation fails and does not attempt to close the remaining channels. Failure in this method causes the factory and any remaining channels to be aborted rather than closed.

This method is called by Close.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.