CommunicationObject.OnBeginClose(TimeSpan, AsyncCallback, Object) Method

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v6.2.0

Source:

CommunicationObject.cs

Inserts processing after a communication object transitions to the closing state due to the invocation of an asynchronous close operation.

protected:
 abstract IAsyncResult ^ OnBeginClose(TimeSpan timeout, AsyncCallback ^ callback, System::Object ^ state);

protected abstract IAsyncResult OnBeginClose (TimeSpan timeout, AsyncCallback callback, object state);

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

Protected MustOverride Function OnBeginClose (timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters

timeout

TimeSpan

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

callback

AsyncCallback

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

state

Object

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

Returns

IAsyncResult

The IAsyncResult that references the asynchronous on close operation.

Exceptions

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

The BeginClose method calls OnBeginClose if the communication object is initially in the Opened state.

To insert processing after a communication object transitions to a closing state due to the invocation of a synchronous Close operation, use the OnClose(TimeSpan) method.