CommunicationObject.Close Method (TimeSpan)

Causes a communication object to transition from its current state into the closed state within a specified interval of time.

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

public void Close(
	TimeSpan timeout
)

Parameters

timeout
Type: System.TimeSpan

The Timespan that specifies how long the close operation has to complete before timing out.

Implements

ICommunicationObject.Close(TimeSpan)

ExceptionCondition
InvalidOperationException

The communication object is not in a Opened or Opening state and cannot be modified.

ObjectDisposedException

The communication object is in a Closing or Closed state and cannot be modified.

CommunicationObjectFaultedException

The communication object is in a Faulted state and cannot be modified.

TimeoutException

The default interval of time that was allotted for the operation was exceeded before the operation was completed.

This method causes a CommunicationObject to gracefully transition from any state, other than the Closed state, into the Closed state within a specified interval of time. The Close method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages.

The CommunicationObject enters the Closing state and remains in it after the Close method is called until the transition to the Closed state is completed. The transition consists of making successive calls to OnClosing, OnClose(TimeSpan) and OnClosed.

There is also an asynchronous version of the close method that is initiated by calling BeginClose.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft