ICommunicationObject.Close 方法

定义

使通信对象从其当前状态转换为关闭状态。

重载

名称 说明
Close()

使通信对象从其当前状态转换为关闭状态。

Close(TimeSpan)

使通信对象从其当前状态转换为关闭状态。

Close()

Source:
ICommunicationObject.cs
Source:
ICommunicationObject.cs
Source:
ICommunicationObject.cs

使通信对象从其当前状态转换为关闭状态。

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

例外

在处于状态的对象 上调用 < a0/>。

在能够正常关闭之前 ICommunicationObject ,默认的关闭超时时间已过。

注解

此方法导致 ICommunicationObject 正常从 Opened 状态过渡到 Closed 状态。 该方法 Close 允许在返回之前完成任何未完成的工作。 例如,完成发送任何缓冲消息。

进入 ICommunicationObject 状态, Closing 并保留在状态中,直到状态转换 Closed 完成。

Close 达到状态后 Closed 返回。

如果默认的关闭超时在能够正常关闭之前 ICommunicationObject 结束,则会 ICommunicationObject 中止。

如果Close对处于或ICommunicationObjectCreated状态的Opening某个状态调用Faulted,则ICommunicationObject中止。 如果Close调用ICommunicationObjectClosing处于或Closed状态,则调用将立即返回。

还有一个异步版本的 close 方法,通过调用和完成调用BeginCloseClose来启动。

适用于

Close(TimeSpan)

Source:
ICommunicationObject.cs
Source:
ICommunicationObject.cs
Source:
ICommunicationObject.cs

使通信对象从其当前状态转换为关闭状态。

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

参数

timeout
TimeSpan

指定 TimeSpan 发送操作在超时之前必须完成多长时间。

例外

在处于状态的对象 上调用 < a0/>。

超时在能够正常关闭之前 ICommunicationObject 完成。

注解

此方法导致 ICommunicationObject 在指定时间间隔内正常地从 Opened 状态转换到 Closed 状态。 该方法 Close 允许在返回之前完成任何未完成的工作。 例如,完成发送任何缓冲消息。

进入 ICommunicationObject 状态, Closing 并保留在状态中,直到状态转换 Closed 完成。

Close 达到状态后 Closed 返回。

如果超时在能够正常关闭之前 ICommunicationObject 过,则会 ICommunicationObject 中止。

如果Close对处于或ICommunicationObjectCreated状态的Opening某个状态调用Faulted,则ICommunicationObject中止。 如果Close调用ICommunicationObjectClosing处于或Closed状态,则调用将立即返回。

还有一个异步版本的 close 方法,通过调用和完成调用BeginCloseClose来启动。

实施者说明

如果超出指定TimeoutException值,该操作必须引发timeout

适用于