程序包 qhs.interfaces

接口 WSServiceModule

public interface WSServiceModule

WSServiceModule接口用于实现WS服务模块类。

方法概要

修饰符和类型	方法	说明
void	clear()	clear()实例方法用于清除WS服务模块的内部状态。
void	detectedNewStream(ThreadContext tc, Connection conn, WebSocketStream newStream)	detectedNewStream()方法的调用说明qhs检测到新的WS流。
boolean	invoke(ThreadContext tc, Connection conn, WebSocketStream readableStream)	invoke()方法被http处理线程循环不断地调用，直到qhs终止运行。
java.lang.String	update(java.lang.String str)	update()实例方法用于更新服务模块的内部状态。

方法详细资料

detectedNewStream

void detectedNewStream(ThreadContext tc,
                       Connection conn,
                       WebSocketStream newStream)
                throws java.lang.Throwable

detectedNewStream()方法的调用说明qhs检测到新的WS流。如果qhs检测到新的WS流，qhs就调用detectedNewStream()方法。

参数:

tc - 线程上下文。

conn - http连接。

newStream - 新的WS流。

抛出:

java.lang.Throwable

invoke

boolean invoke(ThreadContext tc,
               Connection conn,
               WebSocketStream readableStream)
        throws java.lang.Throwable

invoke()方法被http处理线程循环不断地调用，直到qhs终止运行。

参数:

tc - 线程上下文。

conn - http连接。

readableStream - null值说明是空调用。非null值说明qhs检测到一个WS流是可读的，用户代码可调用readableStream.read()方法读取WebSocket帧。

返回:

true值表示提示http处理线程睡眠100毫秒，false值表示忽略睡眠。

抛出:

java.lang.Throwable

update

java.lang.String update(java.lang.String str)
                 throws java.lang.Throwable

update()实例方法用于更新服务模块的内部状态。用户代码通过调用定义在sysThreadSpecificObjectPool 系统对象上的updateWSServiceModule()方法来更新服务模块的内部状态，updateWSServiceModule()方法 直接调用此处说明的update()方法。

参数:

str - 任意字符串。

返回:

返回值可任意。本方法的返回值通过sysThreadSpecificObjectPool.updateWSServiceModule()传递给用户代码。

抛出:

java.lang.Throwable

clear

void clear()
    throws java.lang.Throwable

clear()实例方法用于清除WS服务模块的内部状态。在qhs终止运行的过程中,qhs调用clear()方法。

抛出:

java.lang.Throwable