ICommunicationObject.BeginClose Method

Definition

Namespace:

System.ServiceModel

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.0.0

Begins an asynchronous operation to close a communication object.

Overloads

BeginClose(AsyncCallback, Object)	Begins an asynchronous operation to close a communication object.
BeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to close a communication object with a specified timeout.

Remarks

This method causes an ICommunicationObject to gracefully transition from the Opened state to the Closed state.

Versions with and without an explicit timeout are provided.

BeginClose(AsyncCallback, Object)

Source:

ICommunicationObject.cs

Begins an asynchronous operation to close a communication object.

public:
 IAsyncResult ^ BeginClose(AsyncCallback ^ callback, System::Object ^ state);

public IAsyncResult BeginClose (AsyncCallback callback, object state);

abstract member BeginClose : AsyncCallback * obj -> IAsyncResult

Public Function BeginClose (callback As AsyncCallback, state As Object) As IAsyncResult

Parameters

callback

AsyncCallback

The AsyncCallback delegate that receives notification of the completion of the asynchronous close operation.

state

Object

An object, specified by the application, that contains state information associated with the asynchronous close operation.

Returns

IAsyncResult

The IAsyncResult that references the asynchronous close operation.

Exceptions

CommunicationObjectFaultedException

BeginClose(AsyncCallback, Object) was called on an object in the Faulted state.

TimeoutException

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

Remarks

This method causes an ICommunicationObject to gracefully transition from any state, other than the Opened state to the Closed state. The BeginClose method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages).

BeginClose(TimeSpan, AsyncCallback, Object)

Source:

ICommunicationObject.cs

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

public:
 IAsyncResult ^ BeginClose(TimeSpan timeout, AsyncCallback ^ callback, System::Object ^ state);

public IAsyncResult BeginClose (TimeSpan timeout, AsyncCallback callback, object state);

abstract member BeginClose : TimeSpan * AsyncCallback * obj -> IAsyncResult

Public Function BeginClose (timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters

timeout

TimeSpan

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

callback

AsyncCallback

The AsyncCallback delegate that receives notification of the completion of the asynchronous close operation.

state

Object

An object, specified by the application, that contains state information associated with the asynchronous close operation.

Returns

IAsyncResult

The IAsyncResult that references the asynchronous close operation.

Exceptions

CommunicationObjectFaultedException

BeginClose(TimeSpan, AsyncCallback, Object) was called on an object in the Faulted state.

TimeoutException

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

Remarks

This method causes an ICommunicationObject to gracefully transition from any state, other than the Opened state to 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).