CommunicationObject.Close Method

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.1

Causes a communication object to transition from its current state into the closed state.

Overloads

Close()	Causes a communication object to transition from its current state into the closed state.
Close(TimeSpan)	Causes a communication object to transition from its current state into the closed state within a specified interval of time.

Close()

Source:

CommunicationObject.cs

Causes a communication object to transition from its current state into the closed state.

C#

public void Close();

Implements

Close()

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

This method causes a CommunicationObject to gracefully transition from any state, other than the Closed state, into the Closed state. The Close method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages.

The CommunicationObject enters the Closing state and remains in it after the Close method is called until the transition to the Closed state is completed. The transition consists of making successive calls to OnClosing, OnClose(TimeSpan), and OnClosed.

There is also an asynchronous version of the close method that is initiated by calling BeginClose.

Close(TimeSpan)

Source:

CommunicationObject.cs

Causes a communication object to transition from its current state into the closed state within a specified interval of time.

C#

public void Close(TimeSpan timeout);

Parameters

timeout

TimeSpan

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

Implements

Close(TimeSpan)

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

This method causes a CommunicationObject to gracefully transition from any state, other than the Closed state, into the Closed state within a specified interval of time. The Close method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages.

The CommunicationObject enters the Closing state and remains in it after the Close method is called until the transition to the Closed state is completed. The transition consists of making successive calls to OnClosing, OnClose(TimeSpan) and OnClosed.

There is also an asynchronous version of the close method that is initiated by calling BeginClose.