CommunicationObject.BeginClose Method (TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to close a communication object with a specified timeout.

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

public IAsyncResult BeginClose(
	TimeSpan timeout,
	AsyncCallback callback,
	Object state
)

Parameters

timeout
Type: System.TimeSpan
The Timespan that specifies how long the close operation has to complete before timing out.
callback
Type: System.AsyncCallback
The AsyncCallback delegate that receives notification of the completion of the asynchronous close operation.
state
Type: System.Object
An object, specified by the application, that contains state information associated with the asynchronous close operation.

Return Value

Type: System.IAsyncResult
The IAsyncResult that references the asynchronous close operation.

Implements

ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object)

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 the CommunicationObject to gracefully transition from any state, other than the Closed state, into the Closed state with in a specified interval of time. The BeginClose method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages). This method calls OnBeginClose(TimeSpan, AsyncCallback, Object) if the communication object was initially in the Opened state.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft