Export (0) Print
Expand All

ICommunicationObject.Close Method (TimeSpan)

Causes a communication object to transition from its current state into the closed state.

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

void Close(
	TimeSpan timeout
)

Parameters

timeout
Type: System.TimeSpan

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

ExceptionCondition
CommunicationObjectFaultedException

Close was called on an object in the Faulted state.

TimeoutException

The timeout elapsed before the ICommunicationObject was able to close gracefully.

This method causes an ICommunicationObject to gracefully transition from the Opened state to 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 ICommunicationObject enters the Closing state and remains in it until the transition to the Closed state is completed.

Close returns once the Closed state is reached.

If the timeout elapses before the ICommunicationObject is able to gracefully close, the ICommunicationObject is aborted.

If Close is called on an ICommunicationObject in the Created, Opening, or Faulted state, the ICommunicationObject is aborted. If Close is called on an ICommunicationObject in the Closing or Closed state, the call returns immediately.

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

Notes to Implementers:

The operation must throw a TimeoutException if the specified timeout is exceeded.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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

.NET Framework

Supported in: 3.5, 3.0

.NET Compact Framework

Supported in: 3.5

Community Additions

ADD
Show:
© 2015 Microsoft