CommunicationObject.OnClose(TimeSpan) Method

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v6.2.0

Source:

CommunicationObject.cs

Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous close operation.

protected:
 abstract void OnClose(TimeSpan timeout);

protected abstract void OnClose (TimeSpan timeout);

abstract member OnClose : TimeSpan -> unit

Protected MustOverride Sub OnClose (timeout As TimeSpan)

Parameters

timeout

TimeSpan

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

Exceptions

CommunicationObjectFaultedException

Close was called on an object in the Faulted state.

TimeoutException

The default interval of time that was allotted for the operation was exceeded before the operation was completed.

CommunicationException

A communication error occurred while closing the object.

Remarks

The Close method calls OnClose 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 an asynchronous BeginClose operation, use the OnBeginClose method.