ICommunicationObject.Close メソッド

定義

通信オブジェクトを、現在の状態から Closed 状態に遷移させます。Causes a communication object to transition from its current state into the closed state.

オーバーロード

Close()

通信オブジェクトを、現在の状態から Closed 状態に遷移させます。Causes a communication object to transition from its current state into the closed state.

Close(TimeSpan)

通信オブジェクトを、現在の状態から Closed 状態に遷移させます。Causes a communication object to transition from its current state into the closed state.

Close()

通信オブジェクトを、現在の状態から Closed 状態に遷移させます。Causes a communication object to transition from its current state into the closed state.

public:
 void Close();
public void Close ();
abstract member Close : unit -> unit
Public Sub Close ()

例外

Close() が、Faulted 状態のオブジェクトで呼び出されました。Close() was called on an object in the Faulted state.

ICommunicationObject を正常にクローズする前に、既定の close タイムアウトが経過しました。The default close timeout elapsed before the ICommunicationObject was able to close gracefully.

注釈

このメソッドは、ICommunicationObjectOpened 状態から Closed 状態に正常に遷移させます。This method causes an ICommunicationObject to gracefully transition from the Opened state to the Closed state. Close メソッドにより、戻る前に未完了の作業を完了できます。The Close method allows any unfinished work to be completed before returning. たとえば、バッファー内のメッセージの送信を完了します)。For example, finish sending any buffered messages).

ICommunicationObjectClosing 状態に入り、Closed 状態への遷移が完了するまでその状態を保ちます。The ICommunicationObject enters the Closing state and remains in it until the transition to the Closed state is completed.

Close は、Closed 状態に達した後で返ります。Close returns once the Closed state is reached.

ICommunicationObject を正常にクローズする前に既定の close タイムアウトが経過した場合、ICommunicationObject は中止されます。If the default close timeout elapses before the ICommunicationObject is able to close gracefully, the ICommunicationObject is aborted.

Close 状態、ICommunicationObject 状態、またはCreated 状態にある Opening に対して Faulted が呼び出された場合、ICommunicationObject は中止されます。If Close is called on an ICommunicationObject in the Created, Opening, or Faulted state, the ICommunicationObject is aborted. Close 状態または ICommunicationObject 状態にある Closing に対して Closed が呼び出された場合、その呼び出しは直ちに返ります。If Close is called on an ICommunicationObject in the Closing or Closed state, the call returns immediately.

また、BeginClose を呼び出して開始し、Close を呼び出して完了する close メソッドの非同期バージョンもあります。There is also an asynchronous version of the close method that is initiated by calling BeginClose and completed by calling Close.

Close(TimeSpan)

通信オブジェクトを、現在の状態から Closed 状態に遷移させます。Causes a communication object to transition from its current state into the closed state.

public:
 void Close(TimeSpan timeout);
public void Close (TimeSpan timeout);
abstract member Close : TimeSpan -> unit
Public Sub Close (timeout As TimeSpan)

パラメーター

timeout
TimeSpan

送信操作を完了する必要がある、タイムアウトまでの制限時間を指定する TimeSpanThe TimeSpan that specifies how long the send operation has to complete before timing out.

例外

Close() が、Faulted 状態のオブジェクトで呼び出されました。Close() was called on an object in the Faulted state.

ICommunicationObject を正常にクローズする前に、タイムアウトが経過しました。The timeout elapsed before the ICommunicationObject was able to close gracefully.

注釈

このメソッドは、ICommunicationObject を、指定した時間内で Opened 状態から Closed 状態に正常に遷移させます。This method causes an ICommunicationObject to gracefully transition from the Opened state to the Closed state within a specified interval of time. Close メソッドにより、戻る前に未完了の作業を完了できます。The Close method allows any unfinished work to be completed before returning. たとえば、バッファー内のメッセージの送信を完了します)。For example, finish sending any buffered messages).

ICommunicationObjectClosing 状態に入り、Closed 状態への遷移が完了するまでその状態を保ちます。The ICommunicationObject enters the Closing state and remains in it until the transition to the Closed state is completed.

Close は、Closed 状態に達した後で返ります。Close returns once the Closed state is reached.

ICommunicationObject を正常にクローズする前にタイムアウトが経過した場合、ICommunicationObject は中止されます。If the timeout elapses before the ICommunicationObject is able to gracefully close, the ICommunicationObject is aborted.

Close 状態、ICommunicationObject 状態、またはCreated 状態にある Opening に対して Faulted が呼び出された場合、ICommunicationObject は中止されます。If Close is called on an ICommunicationObject in the Created, Opening, or Faulted state, the ICommunicationObject is aborted. Close 状態または ICommunicationObject 状態にある Closing に対して Closed が呼び出された場合、その呼び出しは直ちに返ります。If Close is called on an ICommunicationObject in the Closing or Closed state, the call returns immediately.

また、BeginClose を呼び出して開始し、Close を呼び出して完了する close メソッドの非同期バージョンもあります。There is also an asynchronous version of the close method that is initiated by calling BeginClose and completed by calling Close.

注意 (実装者)

この操作では指定の TimeoutException を超えた場合に timeout をスローする必要があります。The operation must throw a TimeoutException if the specified timeout is exceeded.

適用対象