net.ymate.platform.serv

Interface ISessionManager<SESSION_WRAPPER extends ISessionWrapper<?,?>,SESSION_ID,MESSAGE_TYPE>

Type Parameters:

SESSION_WRAPPER - 会话包装器类型

SESSION_ID - 会话标识类型

MESSAGE_TYPE - 消息类型

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractSessionManager, NioSessionManager, NioUdpSessionManager

public interface ISessionManager<SESSION_WRAPPER extends ISessionWrapper<?,?>,SESSION_ID,MESSAGE_TYPE>
extends AutoCloseable

客户端会话管理器接口

Author:

刘镇 (suninformation@163.com) on 2018/11/14 11:10 AM

Method Summary

Modifier and Type	Method and Description
void	closeSessionWrapper(SESSION_WRAPPER sessionWrapper) 关闭会话并从会话管理器中移除
boolean	contains(SESSION_ID sessionId) 判断指定的sessionId是否存在
ISessionListener<SESSION_WRAPPER>	getSessionListener() 获取会话事件监听器
void	idleChecker(ISessionIdleChecker<SESSION_WRAPPER,SESSION_ID,MESSAGE_TYPE> sessionIdleChecker) 设置会话空闲检查器
void	initialize() 初始化
boolean	sendTo(SESSION_ID sessionId, MESSAGE_TYPE message) 向目标客户端发送消息
long	sessionCount() 获取会话实例数量
SESSION_WRAPPER	sessionWrapper(SESSION_ID sessionId) 获取指定sessionId的会话包装器实例
Collection<SESSION_WRAPPER>	sessionWrappers() 返回所有的会话包装器实例(只读)
void	speedometer(Speedometer speedometer) 设置速度计数器(仅在服务启动前调用有效)

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

initialize

void initialize()
         throws Exception

初始化

Throws:

Exception - 初始过程中产生的任何异常

sessionWrapper

SESSION_WRAPPER sessionWrapper(SESSION_ID sessionId)

获取指定sessionId的会话包装器实例

Parameters:

sessionId - 会话ID

Returns:

若不存在则返回null

sessionWrappers

Collection<SESSION_WRAPPER> sessionWrappers()

返回所有的会话包装器实例(只读)

Returns:

会话包装器实例集合

contains

boolean contains(SESSION_ID sessionId)

判断指定的sessionId是否存在

Parameters:

sessionId - 会话ID

Returns:

若不存在则返回false

closeSessionWrapper

void closeSessionWrapper(SESSION_WRAPPER sessionWrapper)

关闭会话并从会话管理器中移除

Parameters:

sessionWrapper - 会话包装器实例

sessionCount

long sessionCount()

获取会话实例数量

Returns:

会话数量值

getSessionListener

ISessionListener<SESSION_WRAPPER> getSessionListener()

获取会话事件监听器

Returns:

会话事件监听器接口实现

speedometer

void speedometer(Speedometer speedometer)

设置速度计数器(仅在服务启动前调用有效)

Parameters:

speedometer - 速度计数器

idleChecker

void idleChecker(ISessionIdleChecker<SESSION_WRAPPER,SESSION_ID,MESSAGE_TYPE> sessionIdleChecker)

设置会话空闲检查器

Parameters:

sessionIdleChecker - 会话空闲检查器接口实现类

sendTo

boolean sendTo(SESSION_ID sessionId,
               MESSAGE_TYPE message)
        throws IOException

向目标客户端发送消息

Parameters:

sessionId - 目标客户端会话唯一标识

message - 消息对象

Returns:

若指定的目标客户端标识存在且有效则返回true

Throws:

IOException - 可能产生的异常