3.3.1 CommunicationObject与DefaultCommunicationTimeouts
WCF绑定模型涉及多种类型的组件,比如信道、信道监听器、信道工厂等。从功能上讲,这些对象都是为通信服务的,可以把它们称为通信对象(Communication Object)。对于这些通信对象来说,在通信不同的阶段,它们往往具有不同的状态;从整个通信的生命周期来看,在不同阶段的过渡过程中,它们具有一些相似的状态转换方式。
ICommunicationObject与CommunicationObject
WCF定义了一个特殊的接口,System.ServiceModel.ICommunicationObject,用以管理通信对象的状态和状态的转换,下面是ICommunicationObject的定义。
public interface ICommunicationObject { //事件 event EventHandler Closed; event EventHandler Closing; event EventHandler Faulted; event EventHandler Opened; event EventHandler Opening; //方法 void Open(); void Open(TimeSpan timeout); IAsyncResult BeginOpen(AsyncCallback callback, object state); IAsyncResult BeginOpen(TimeSpan timeout, AsyncCallback callback, object state); void EndOpen(IAsyncResult result); void Close(); void Close(TimeSpan timeout); IAsyncResult BeginClose(AsyncCallback callback, object state); IAsyncResult BeginClose(TimeSpan timeout, AsyncCallback callback, object state); void EndClose(IAsyncResult result); void Abort(); //属性 CommunicationState State { get; } }
ICommunicationObject的State属性,表示通信对象当前所处的状态。该属性通过System.ServiceModel.CommunicationState枚举表示,通信对象6种典型的状态都定义在CommunicationState中:被创建(Created)、正被开启(Opening)、已经被开启(Opened)、正被关闭(Closing)、已经被关闭(Closed)、已经出错(Faulted)。
public enum CommunicationState { Created, Opening, Opened, Closing, Closed, Faulted }
ICommunicationObject定义了以下3种类型的成员。
● 事件:在状态转换发生之前,或者是发生之后,会触发相应的事件。通过注册相应的事件,可以在某个状态转换环节中注入需要的处理操作。
● 方法:定义了3种类型的操作:开启(open)、关闭(close)、中止(abort)。“关闭”和“中止”在功能上具有相似之处,都是断开连接、回收对象。不过它们也有不同之处,很多英文文章或书籍将“关闭(close)”称为“graceful shutdown(优雅地关闭)”,而将“中止(abort)”描述为“immediate shutdown(立即关闭)”。拿关闭电脑来说,前面一种是通过操作系统进行关闭,后一种则是直接切断电源。对于前一种方式,在关闭过程中,会进行一些IO操作。
● 属性:上面已经提到,属性State代表通信对象当前所处的状态。
由于WCF处理的是跨应用程序域(Application Domain)、跨机器、跨网络的通信,所以WCF服务调用的大部分时间都在进行像网络传输这样的IO操作,这种IO绑定(IO bound)的操作是采用异步编程最为常用的一种类型。ICommunicationObject中的开启和关闭操作,既定义了一个同步方法,也按照异步编程模型(APM:Asynchronous Programming Mode)定义了异步方法。
除了简单定义ICommunicationObject接口之外,WCF还定义了一个实现了该接口的基类:System.ServiceModel.Channels.CommunicationObject。
public abstract class CommunicationObject : ICommunicationObject { //类型成员 }
在WCF体系中,很多基于通信的基类都继承自CommunicationObject,比如信道的基类System.ServiceModel.Channels.ChannelBase;信道工厂和信道监听器的基类System. ServiceModel.Channels.ChannelManagerBase;ServiceHost的基类System.ServiceModel. ServiceHostBase;信道分发器的基类System.ServiceModel.Dispatcher.ChannelDispatcherBase等。大体的继承结构如图3-8所示。
图3-8 CommunicationObject继承关系
IDefaultCommunicationTimeouts
由于WCF须要跨域网络进行服务的访问,较一般的调用方法,服务访问所花的时间往往更长,所以对超时的处理显得异常重要。就消息的发送来说,可能由于网络的故障,该消息在一段时间内根本无法成功发送,客户端程序不可能无限制地等待下去。一般的情况下,我们会设定一个操作执行的所允许的最大时限,一旦超时则取消操作,并进行相应的超时处理。
回顾一下ICommunicationObject的Open和BeginOpen方法,会发现它们各有两个重载,其中一个具有TimeSpan类型的timeout参数,另一个则没有。这里的timeout参数实际上代表Open方法执行的超时时间,如果Open操作执行的时间过长,一旦超过了设定的时限,操作将被立即中止。
public interface ICommunicationObject { void Open(); void Open(TimeSpan timeout); IAsyncResult BeginOpen(AsyncCallback callback, object state); IAsyncResult BeginOpen(TimeSpan timeout, AsyncCallback callback, object state); //其他成员 }
可能读者会问,对于没有timeout参数的操作,比如无参的Open方法,是否意味着没有这样的超时限制,操作将会一直执行下去直到操作正常结束呢?答案是否定的,对于没有显式指定超时时限的操作,采用的是默认的超时时限。WCF为所有需要默认超时时限的通信对象定义了一个接口:System.ServiceModel.IDefaultCommunicationTimeouts。在IDefaultCommunicationTimeouts中定义了4个Timeout属性,分别为开启、关闭、发送、接收4大操作的超时时限。
public interface IDefaultCommunicationTimeouts { TimeSpan CloseTimeout { get; } TimeSpan OpenTimeout { get; } TimeSpan ReceiveTimeout { get; } TimeSpan SendTimeout { get; } }
很多基于通信的基类都实现了IDefaultCommunicationTimeouts接口,比如信道的基类System.ServiceModel.Channels.ChannelBase信道工厂和信道监听器的基类System.ServiceModel. Channels.ChannelManagerBase;以及所有绑定对象的基类System.ServiceModel.Channels. Binding等。