org.noear.solon.core.message

接口 Session

public interface Session

会话（为 Message + Listener 架构服务 ）

从以下版本开始:

1.0

作者:

noear

方法概要

限定符和类型	方法和说明
default Object	attr(String name) 获取特性
Map<String,Object>	attrMap() 特性集合
default void	attrSet(String name, Object value) 设置特性
default void	close() 关闭会话
int	flag() 标识（为特定业务提供帮助）
void	flagSet(int flag) 标识设置
<T> T	getAttachment() 获取附件
boolean	getHandshaked() 获取握手状态
InetSocketAddress	getLocalAddress() 本地地址
Collection<Session>	getOpenSessions() 获取所有会话
InetSocketAddress	getRemoteAddress() 远程地址
String	header(String name) 请求头
NvMap	headerMap() 请求头集合
void	headerSet(String name, String value) 设置请求头
boolean	isSecure() 是否是安全的
boolean	isValid() 是否是有效的
default Listener	listener() 当前实例监听者
default void	listener(Listener listener) 当前实例监听者（ListenEndpoint 为路径监听者，不限实例）
MethodType	method() 方法
String	param(String name) 请求参数
NvMap	paramMap() 请求参数集合
void	paramSet(String name, String value) 设置请求参数
String	path() 路径（socket 可能为null）
default NvMap	pathMap(String expr) 获取请求的URI路径变量,根据路径表达式
String	pathNew() 获取新路径，不存在则返回原路径
void	pathNew(String pathNew) 设置新路径
Object	real()
void	send(Message message) 发送消息
void	send(String message) 发送消息
void	sendAndCallback(Message message, BiConsumer<Message,Throwable> callback) 发送消息并异步回调
void	sendAndCallback(String message, BiConsumer<String,Throwable> callback) 发送消息并异步回调
Message	sendAndResponse(Message message) 发送消息并等待响应
Message	sendAndResponse(Message message, int timeout) 发送消息并等待响应
String	sendAndResponse(String message) 发送消息并等待响应
String	sendAndResponse(String message, int timeout) 发送消息并等待响应
void	sendAsync(Message message) 发送消息
void	sendAsync(String message) 发送消息
void	sendHandshake(Message message) 发送握手
Message	sendHandshakeAndResponse(Message message) 发送握手并等待响应
void	sendHeartbeat() 发送心跳
default void	sendHeartbeatAuto(int intervalSeconds) 已过时。 2.5
String	sessionId() 会话ID
void	setAttachment(Object obj) 设置附件
void	setHandshaked(boolean handshaked) 设置握手状态
void	startHeartbeatAuto(int intervalSeconds) 开始自动心跳
void	stopHeartbeatAuto() 停目自动心跳
URI	uri() URI（socket 可能为null）

方法详细资料

real

Object real()

sessionId

String sessionId()

会话ID

method

MethodType method()

方法

uri

URI uri()

URI（socket 可能为null）

path

String path()

路径（socket 可能为null）

pathNew

void pathNew(String pathNew)

设置新路径

pathNew

String pathNew()

获取新路径，不存在则返回原路径

pathMap

default NvMap pathMap(String expr)

获取请求的URI路径变量,根据路径表达式

header

String header(String name)

请求头

headerSet

void headerSet(String name,
               String value)

设置请求头

headerMap

NvMap headerMap()

请求头集合

param

String param(String name)

请求参数

paramSet

void paramSet(String name,
              String value)

设置请求参数

paramMap

NvMap paramMap()

请求参数集合

attr

default Object attr(String name)

获取特性

attrSet

default void attrSet(String name,
                     Object value)

设置特性

attrMap

Map<String,Object> attrMap()

特性集合

flag

int flag()

标识（为特定业务提供帮助）

flagSet

void flagSet(int flag)

标识设置

sendAsync

void sendAsync(String message)

发送消息

sendAsync

void sendAsync(Message message)

发送消息

send

void send(String message)

发送消息

send

void send(Message message)

发送消息

sendAndResponse

String sendAndResponse(String message)

发送消息并等待响应

sendAndResponse

String sendAndResponse(String message,
                       int timeout)

发送消息并等待响应

sendAndResponse

Message sendAndResponse(Message message)

发送消息并等待响应

sendAndResponse

Message sendAndResponse(Message message,
                        int timeout)

发送消息并等待响应

sendAndCallback

void sendAndCallback(String message,
                     BiConsumer<String,Throwable> callback)

发送消息并异步回调

sendAndCallback

void sendAndCallback(Message message,
                     BiConsumer<Message,Throwable> callback)

发送消息并异步回调

listener

default void listener(Listener listener)

当前实例监听者（ListenEndpoint 为路径监听者，不限实例）

listener

default Listener listener()

当前实例监听者

close

default void close()
            throws IOException

关闭会话

抛出:

IOException

isValid

boolean isValid()

是否是有效的

isSecure

boolean isSecure()

是否是安全的

setHandshaked

void setHandshaked(boolean handshaked)

设置握手状态

getHandshaked

boolean getHandshaked()

获取握手状态

getRemoteAddress

InetSocketAddress getRemoteAddress()

远程地址

getLocalAddress

InetSocketAddress getLocalAddress()

本地地址

setAttachment

void setAttachment(Object obj)

设置附件

getAttachment

<T> T getAttachment()

获取附件

getOpenSessions

Collection<Session> getOpenSessions()

获取所有会话

sendHeartbeat

void sendHeartbeat()

发送心跳

sendHandshake

void sendHandshake(Message message)

发送握手

sendHandshakeAndResponse

Message sendHandshakeAndResponse(Message message)

发送握手并等待响应

sendHeartbeatAuto

@Deprecated
default void sendHeartbeatAuto(int intervalSeconds)

已过时。 2.5

开始自动心跳

startHeartbeatAuto

void startHeartbeatAuto(int intervalSeconds)

开始自动心跳

stopHeartbeatAuto

void stopHeartbeatAuto()

停目自动心跳