net.ymate.platform.serv.nio

Interface INioSession

All Superinterfaces:

AutoCloseable, Closeable, Serializable

All Known Implementing Classes:

AbstractNioSession, NioSession, NioUdpSession

public interface INioSession
extends Serializable, Closeable

Author:

刘镇 (suninformation@163.com) on 15/11/15 下午6:10

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	INioSession.Status 会话状态枚举

Method Summary

Modifier and Type	Method and Description
<T> T	attr(String key) 获取指定键名的属性值
void	attr(String key, Object value) 添加属性
Map<String,Object>	attrs() 获取属性映射
void	closeNow() 立即关闭
boolean	connectSync(long time) 等待连接指定time时间
void	finishConnect() 结束等待连接
String	id() 获取会话唯一标识
boolean	isConnected() 判断会话状态是否为CONNECTED
boolean	isNew() 判断会话状态是否为NEW
boolean	isUdp() 判断是否为UDP会话
long	lastTouchTime() 获取最后更新会话状态的时间(毫秒)
void	read() 从会话读取数据
void	registerEvent(int ops) 注册事件
String	remoteAddress() 获取远程IP地址端口号
InetSocketAddress	remoteSocketAddress() 获取远程套接字地址对象
SelectionKey	selectionKey() 获取选择键
void	selectionKey(SelectionKey key) 设置选择键
void	send(Object message) 向会话发送消息
INioSession.Status	status() 获取当前会话状态
void	status(INioSession.Status status) 设置当前会话状态
void	touch() 更新会话活动状态
void	write() 向会话写入数据

Methods inherited from interface java.io.Closeable

close

Method Detail

id

String id()

获取会话唯一标识

Returns:

返回会话唯一标识

isNew

boolean isNew()

判断会话状态是否为NEW

Returns:

返回会话状态是否为NEW

isConnected

boolean isConnected()

判断会话状态是否为CONNECTED

Returns:

返回会话状态是否为CONNECTED

remoteSocketAddress

InetSocketAddress remoteSocketAddress()

获取远程套接字地址对象

Returns:

返回远程套接字地址对象

remoteAddress

String remoteAddress()

获取远程IP地址端口号

Returns:

返回远程IP地址端口号

status

INioSession.Status status()

获取当前会话状态

Returns:

返回当前会话状态

touch

void touch()

更新会话活动状态

lastTouchTime

long lastTouchTime()

获取最后更新会话状态的时间(毫秒)

Returns:

返回最后更新会话状态的时间(毫秒)

attrs

Map<String,Object> attrs()

获取属性映射

Returns:

返回属性映射对象

attr

<T> T attr(String key)

获取指定键名的属性值

Type Parameters:

T - 键值类型

Parameters:

key - 键名

Returns:

返回属性值对象

attr

void attr(String key,
          Object value)

添加属性

Parameters:

key - 键名

value - 键值

send

void send(Object message)
   throws IOException

向会话发送消息

Parameters:

message - 消息对象

Throws:

IOException - 可能产生的异常

registerEvent

void registerEvent(int ops)
            throws IOException

注册事件

Parameters:

ops - 事件参数

Throws:

IOException - 可能产生的异常

selectionKey

void selectionKey(SelectionKey key)

设置选择键

Parameters:

key - 选择键

selectionKey

SelectionKey selectionKey()

获取选择键

Returns:

返回当前选择键

connectSync

boolean connectSync(long time)

等待连接指定time时间

Parameters:

time - 等待时间(毫秒)

Returns:

返回true表示正常结束等待

finishConnect

void finishConnect()

结束等待连接

isUdp

boolean isUdp()

判断是否为UDP会话

Returns:

返回true表示是UDP会话

status

void status(INioSession.Status status)

设置当前会话状态

Parameters:

status - 会话状态对象

closeNow

void closeNow()
       throws IOException

立即关闭

Throws:

IOException - 可能产生的I/O异常

read

void read()
   throws IOException

从会话读取数据

Throws:

IOException - 可能产生的I/O异常

write

void write()
    throws IOException

向会话写入数据

Throws:

IOException - 可能产生的I/O异常