org.noear.socketd.transport.core

接口 Session

所有超级接口:

AutoCloseable, ClientSession, Closeable

所有已知实现类:

SessionBase, SessionDefault

public interface Session
extends ClientSession, Closeable

会话

从以下版本开始:

2.0

作者:

noear

方法概要

限定符和类型	方法和说明
<T> T	attr(String name) 获取属性
<T> Session	attrDel(String name) 删除属性
boolean	attrHas(String name) 是有属性
Map<String,Object>	attrMap() 获取所有属性
<T> T	attrOrDefault(String name, T def) 获取属性或默认值
<T> Session	attrPut(String name, T value) 放置属性
Handshake	handshake() 获取握手信息
boolean	isClosing() 是否关闭中
boolean	isValid() 是否有效
long	liveTime() 最后活动时间
InetSocketAddress	localAddress() 获取本地地址
default String	name() broker player name
String	param(String name) 获取握手参数
String	paramOrDefault(String name, String def) 获取握手参数或默认值
String	path() 获取握手路径
void	pathNew(String pathNew) 设置握手新路径
void	reconnect() 手动重连（一般是自动）
InetSocketAddress	remoteAddress() 获取远程地址
void	reply(Message from, Entity entity) 答复
void	replyEnd(Message from, Entity entity) 答复并结束（即最后一次答复）
void	sendAlarm(Message from, String alarm) 发送告警
void	sendPing() 手动发送 Ping（一般是自动）
String	sessionId() 获取会话Id

从接口继承的方法 org.noear.socketd.transport.client.ClientSession

close, closeStarting, preclose, send, sendAndRequest, sendAndRequest, sendAndSubscribe, sendAndSubscribe

方法详细资料

remoteAddress

InetSocketAddress remoteAddress()
                         throws IOException

获取远程地址

抛出:

IOException

localAddress

InetSocketAddress localAddress()
                        throws IOException

获取本地地址

抛出:

IOException

handshake

Handshake handshake()

获取握手信息

name

default String name()

broker player name

从以下版本开始:

2.1

param

String param(String name)

获取握手参数

参数:

name - 名字

paramOrDefault

String paramOrDefault(String name,
                      String def)

获取握手参数或默认值

参数:

name - 名字

def - 默认值

path

String path()

获取握手路径

pathNew

void pathNew(String pathNew)

设置握手新路径

attrMap

Map<String,Object> attrMap()

获取所有属性

attrHas

boolean attrHas(String name)

是有属性

参数:

name - 名字

attr

<T> T attr(String name)

获取属性

参数:

name - 名字

attrOrDefault

<T> T attrOrDefault(String name,
                    T def)

获取属性或默认值

参数:

name - 名字

def - 默认值

attrPut

<T> Session attrPut(String name,
                    T value)

放置属性

参数:

name - 名字

value - 值

attrDel

<T> Session attrDel(String name)

删除属性

参数:

name - 名字

isValid

boolean isValid()

是否有效

指定者:

isValid 在接口中 ClientSession

isClosing

boolean isClosing()

是否关闭中

指定者:

isClosing 在接口中 ClientSession

sessionId

String sessionId()

获取会话Id

指定者:

sessionId 在接口中 ClientSession

liveTime

long liveTime()

最后活动时间

reconnect

void reconnect()
        throws IOException

手动重连（一般是自动）

指定者:

reconnect 在接口中 ClientSession

抛出:

IOException

sendPing

void sendPing()
       throws IOException

手动发送 Ping（一般是自动）

抛出:

IOException

sendAlarm

void sendAlarm(Message from,
               String alarm)
        throws IOException

发送告警

抛出:

IOException

reply

void reply(Message from,
           Entity entity)
    throws IOException

答复

参数:

from - 来源消息

entity - 实体

抛出:

IOException

replyEnd

void replyEnd(Message from,
              Entity entity)
       throws IOException

答复并结束（即最后一次答复）

参数:

from - 来源消息

entity - 实体

抛出:

IOException