net.ymate.platform.serv

Class AbstractSessionManager<SESSION_WRAPPER extends ISessionWrapper<?,?>,SESSION_ID,MESSAGE_TYPE>

java.lang.Object

net.ymate.platform.serv.AbstractSessionManager<SESSION_WRAPPER,SESSION_ID,MESSAGE_TYPE>

Type Parameters:

SESSION_WRAPPER - 会话包装类型

SESSION_ID - 会话标识类型

MESSAGE_TYPE - 消息类型

All Implemented Interfaces:

AutoCloseable, ISessionManager<SESSION_WRAPPER,SESSION_ID,MESSAGE_TYPE>

Direct Known Subclasses:

NioSessionManager, NioUdpSessionManager

public abstract class AbstractSessionManager<SESSION_WRAPPER extends ISessionWrapper<?,?>,SESSION_ID,MESSAGE_TYPE>
extends Object
implements ISessionManager<SESSION_WRAPPER,SESSION_ID,MESSAGE_TYPE>

Author:

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

Constructor Summary

Constructors

Constructor and Description
AbstractSessionManager(IServerCfg serverCfg, INioCodec codec, long idleTimeInMillis) 构造器

Method Summary

Modifier and Type	Method and Description
protected abstract IServer<?,?>	buildServer(IServerCfg serverCfg, INioCodec codec) 根据服务端配置构建服务端实例
protected abstract SESSION_WRAPPER	buildSessionWrapper(INioSession session, InetSocketAddress socketAddress) 根据会话对象构建包装器
void	close()
void	closeSessionWrapper(SESSION_WRAPPER sessionWrapper) 关闭会话并从会话管理器中移除
boolean	contains(SESSION_ID sessionId) 判断指定的sessionId是否存在
void	idleChecker(ISessionIdleChecker<SESSION_WRAPPER,SESSION_ID,MESSAGE_TYPE> sessionIdleChecker) 设置会话空闲检查器
void	initialize() 初始化
protected void	putSessionWrapper(SESSION_ID sessionId, SESSION_WRAPPER sessionWrapper) 将会话包装器对象放入管理器
protected boolean	register(SESSION_WRAPPER session) 执行会话注册逻辑
protected SESSION_WRAPPER	registerSession(INioSession session, InetSocketAddress socketAddress) 注册客户端会话
protected SESSION_WRAPPER	removeSessionWrapper(SESSION_ID sessionId) 移除会话
long	sessionCount() 获取会话实例数量
SESSION_WRAPPER	sessionWrapper(SESSION_ID sessionId) 获取指定sessionId的会话包装器实例
Collection<SESSION_WRAPPER>	sessionWrappers() 返回所有的会话包装器实例(只读)
void	speedometer(Speedometer speedometer) 设置速度计数器(仅在服务启动前调用有效)
void	speedTouch() 触发速度计数

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.ymate.platform.serv.ISessionManager

getSessionListener, sendTo

Constructor Detail

AbstractSessionManager

public AbstractSessionManager(IServerCfg serverCfg,
                              INioCodec codec,
                              long idleTimeInMillis)

构造器

Parameters:

serverCfg - 服务端配置接口实现

codec - 编解码器接口实现

idleTimeInMillis - 会话空闲时间毫秒值, 小于等于0表示不开启空闲检查

Method Detail

sessionWrapper

public SESSION_WRAPPER sessionWrapper(SESSION_ID sessionId)

Description copied from interface: ISessionManager

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

Specified by:

sessionWrapper in interface ISessionManager<SESSION_WRAPPER extends ISessionWrapper<?,?>,SESSION_ID,MESSAGE_TYPE>

Parameters:

sessionId - 会话ID

Returns:

若不存在则返回null

sessionWrappers

public Collection<SESSION_WRAPPER> sessionWrappers()

Description copied from interface: ISessionManager

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

Specified by:

sessionWrappers in interface ISessionManager<SESSION_WRAPPER extends ISessionWrapper<?,?>,SESSION_ID,MESSAGE_TYPE>

Returns:

会话包装器实例集合

contains

public boolean contains(SESSION_ID sessionId)

Description copied from interface: ISessionManager

判断指定的sessionId是否存在

Specified by:

contains in interface ISessionManager<SESSION_WRAPPER extends ISessionWrapper<?,?>,SESSION_ID,MESSAGE_TYPE>

Parameters:

sessionId - 会话ID

Returns:

若不存在则返回false

closeSessionWrapper

public void closeSessionWrapper(SESSION_WRAPPER sessionWrapper)

Description copied from interface: ISessionManager

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

Specified by:

closeSessionWrapper in interface ISessionManager<SESSION_WRAPPER extends ISessionWrapper<?,?>,SESSION_ID,MESSAGE_TYPE>

Parameters:

sessionWrapper - 会话包装器实例

sessionCount

public long sessionCount()

Description copied from interface: ISessionManager

获取会话实例数量

Specified by:

sessionCount in interface ISessionManager<SESSION_WRAPPER extends ISessionWrapper<?,?>,SESSION_ID,MESSAGE_TYPE>

Returns:

会话数量值

speedometer

public void speedometer(Speedometer speedometer)

Description copied from interface: ISessionManager

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

Specified by:

speedometer in interface ISessionManager<SESSION_WRAPPER extends ISessionWrapper<?,?>,SESSION_ID,MESSAGE_TYPE>

Parameters:

speedometer - 速度计数器

idleChecker

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

Description copied from interface: ISessionManager

设置会话空闲检查器

Specified by:

idleChecker in interface ISessionManager<SESSION_WRAPPER extends ISessionWrapper<?,?>,SESSION_ID,MESSAGE_TYPE>

Parameters:

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

speedTouch

public void speedTouch()

触发速度计数

registerSession

protected SESSION_WRAPPER registerSession(INioSession session,
                                          InetSocketAddress socketAddress)

注册客户端会话

Parameters:

session - 会话对象

socketAddress - 目标来源套接字地址

Returns:

返回注册的客户端会话包装器对象

register

protected boolean register(SESSION_WRAPPER session)

执行会话注册逻辑

Parameters:

session - 会话包装器对象

Returns:

返回值为false表示不向管理器注册当前会话

putSessionWrapper

protected void putSessionWrapper(SESSION_ID sessionId,
                                 SESSION_WRAPPER sessionWrapper)

将会话包装器对象放入管理器

Parameters:

sessionId - 会话标识符

sessionWrapper - 会话包装器对象

removeSessionWrapper

protected SESSION_WRAPPER removeSessionWrapper(SESSION_ID sessionId)

移除会话

Parameters:

sessionId - 会话标识符

Returns:

返回被移除的会话对象, 若不存在则返回null

buildSessionWrapper

protected abstract SESSION_WRAPPER buildSessionWrapper(INioSession session,
                                                       InetSocketAddress socketAddress)

根据会话对象构建包装器

Parameters:

session - 会话对象

socketAddress - 目标来源套接字地址

Returns:

返回包装器对象

buildServer

protected abstract IServer<?,?> buildServer(IServerCfg serverCfg,
                                            INioCodec codec)

根据服务端配置构建服务端实例

Parameters:

serverCfg - 服务端配置

codec - 编解码器

Returns:

返回构建后的服务端接口实例对象

initialize

public void initialize()
                throws Exception

Description copied from interface: ISessionManager

初始化

Specified by:

initialize in interface ISessionManager<SESSION_WRAPPER extends ISessionWrapper<?,?>,SESSION_ID,MESSAGE_TYPE>

Throws:

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

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception