This topic has not yet been rated - Rate this topic

CommunicationObject.BeginClose Method (AsyncCallback, Object)

.NET Framework 4.5

Begins an asynchronous operation to close a communication object.

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

public IAsyncResult BeginClose(
	AsyncCallback callback,
	Object state
)

Parameters

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(AsyncCallback, Object)

Exceptions

Exception	Condition
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.

Remarks

This method causes the CommunicationObject to gracefully transition from any state, other than the Closed state, into the Closed state within a default 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 OnBeginOpen(TimeSpan, AsyncCallback, Object) if the communication object was initially in the Opened state.

Version Information

.NET Framework

Supported in: 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

Platforms

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.

Reference

CommunicationObject Class

BeginClose Overload

System.ServiceModel.Channels Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)