cn.foxtech.channel.common.api

类 ChannelServerAPI

java.lang.Object

cn.foxtech.channel.common.api.ChannelServerAPI

public class ChannelServerAPI
extends Object

Channel服务的API接口 每一种具体的Channel模块会去实现这些方法，那么Channel框架在控制这些Channel模块的时候，会展现出相应的特性

构造器概要

构造器

构造器和说明
ChannelServerAPI()

方法概要

限定符和类型	方法和说明
void	closeChannel(String channelName, Map<String,Object> channelParam) 关闭通道
ChannelRespondVO	execute(ChannelRequestVO requestVO) 执行主从半双工操作：上位机向设备问询，并等待设备的回答，直到设备响应或者超时
Object	getReportLock() 获得上报通知的锁对象 默认：ChannelServerAPI的派生类，也就是各个ChannelService的实例 可以通过重载该方法，来指定其他作为同步锁的实例对象
ChannelRespondVO	manageChannel(ChannelRequestVO requestVO) 管理通道操作：上层服务，对通道的管理操作
void	openChannel(String channelName, Map<String,Object> channelParam) 打开通道
void	publish(ChannelRequestVO requestVO) 执行发布操作：上位机向设备单向发送报文，不需要等待设备的返回
List<ChannelRespondVO>	report() 设备的主动上报消息：设备向上位机

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ChannelServerAPI

public ChannelServerAPI()

方法详细资料

execute

public ChannelRespondVO execute(ChannelRequestVO requestVO)
                         throws ServiceException

执行主从半双工操作：上位机向设备问询，并等待设备的回答，直到设备响应或者超时

参数:

requestVO - 请求报文

返回:

返回的json报文

抛出:

ServiceException - 异常信息

publish

public void publish(ChannelRequestVO requestVO)
             throws ServiceException

执行发布操作：上位机向设备单向发送报文，不需要等待设备的返回

参数:

requestVO - 发布报文

抛出:

ServiceException - 异常信息

report

public List<ChannelRespondVO> report()
                              throws ServiceException

设备的主动上报消息：设备向上位机

返回:

上报消息

抛出:

ServiceException - 异常信息

getReportLock

public Object getReportLock()

获得上报通知的锁对象 默认：ChannelServerAPI的派生类，也就是各个ChannelService的实例 可以通过重载该方法，来指定其他作为同步锁的实例对象

返回:

openChannel

public void openChannel(String channelName,
                        Map<String,Object> channelParam)
                 throws Exception

打开通道

参数:

channelName - 通道名称

channelParam - 通道参数

抛出:

Exception - 异常信息

closeChannel

public void closeChannel(String channelName,
                         Map<String,Object> channelParam)

关闭通道

参数:

channelName - 通道名称

channelParam - 通道参数

manageChannel

public ChannelRespondVO manageChannel(ChannelRequestVO requestVO)
                               throws ServiceException

管理通道操作：上层服务，对通道的管理操作

参数:

requestVO - 发布报文

返回:

响应VO

抛出:

ServiceException - 异常信息