org.noear.solon.net.websocket

接口 WebSocket

所有已知实现类:

VxWebSocketImpl, WebSocketBase, WebSocketImpl, WebSocketImpl, WebSocketImpl, WebSocketImpl, WebSocketImpl, WebSocketTimeoutBase

public interface WebSocket

WebSocket 会话接口

从以下版本开始:

2.6

方法概要

限定符和类型	方法和说明
<T> T	attr(java.lang.String name) 获取属性
<T> void	attr(java.lang.String name, T value) 设置属性
boolean	attrHas(java.lang.String name) 是有属性
java.util.Map<java.lang.String,java.lang.Object>	attrMap() 获取所有属性
<T> T	attrOrDefault(java.lang.String name, T def) 获取属性或默认值
void	close() 关闭
long	getIdleTimeout() 获取闲置超时
java.lang.String	id() 会话id
boolean	isSecure() 是否安全
boolean	isValid() 是否有效
java.net.InetSocketAddress	localAddress() 获取本地地址
java.lang.String	name() 名字（由用户设定）
void	nameAs(java.lang.String name) 名字命为
java.lang.String	param(java.lang.String name) 获取参数
void	param(java.lang.String name, java.lang.String value) 添加参数
MultiMap<java.lang.String>	paramMap() 获取参数字典
java.lang.String	paramOrDefault(java.lang.String name, java.lang.String def) 获取参数或默认值
java.lang.String	path() 获取请求路径
void	pathNew(java.lang.String pathNew) 设置新路径
java.net.InetSocketAddress	remoteAddress() 获取远程地址
java.util.concurrent.Future<java.lang.Void>	send(java.nio.ByteBuffer binary) 发送字节
java.util.concurrent.Future<java.lang.Void>	send(java.lang.String text) 发送文本
void	setIdleTimeout(long idleTimeout) 设置闲置超时
java.lang.String	url() 获取请求地址

方法详细资料

id

java.lang.String id()

会话id

name

java.lang.String name()

名字（由用户设定）

nameAs

void nameAs(java.lang.String name)

名字命为

参数:

name - 名字

isValid

boolean isValid()

是否有效

isSecure

boolean isSecure()

是否安全

url

java.lang.String url()

获取请求地址

path

java.lang.String path()

获取请求路径

pathNew

void pathNew(java.lang.String pathNew)

设置新路径

paramMap

MultiMap<java.lang.String> paramMap()

获取参数字典

param

java.lang.String param(java.lang.String name)

获取参数

参数:

name - 参数名

paramOrDefault

java.lang.String paramOrDefault(java.lang.String name,
                                java.lang.String def)

获取参数或默认值

参数:

name - 参数名

def - 默认值

param

void param(java.lang.String name,
           java.lang.String value)

添加参数

参数:

name - 名字

value - 值

remoteAddress

java.net.InetSocketAddress remoteAddress()
                                  throws java.io.IOException

获取远程地址

抛出:

java.io.IOException

localAddress

java.net.InetSocketAddress localAddress()
                                 throws java.io.IOException

获取本地地址

抛出:

java.io.IOException

attrMap

java.util.Map<java.lang.String,java.lang.Object> attrMap()

获取所有属性

attrHas

boolean attrHas(java.lang.String name)

是有属性

参数:

name - 名字

attr

<T> T attr(java.lang.String name)

获取属性

参数:

name - 名字

attrOrDefault

<T> T attrOrDefault(java.lang.String name,
                    T def)

获取属性或默认值

参数:

name - 名字

def - 默认值

attr

<T> void attr(java.lang.String name,
              T value)

设置属性

参数:

name - 名字

value - 值

getIdleTimeout

long getIdleTimeout()

获取闲置超时

setIdleTimeout

void setIdleTimeout(long idleTimeout)

设置闲置超时

send

java.util.concurrent.Future<java.lang.Void> send(java.lang.String text)

发送文本

参数:

text - 文本

send

java.util.concurrent.Future<java.lang.Void> send(java.nio.ByteBuffer binary)

发送字节

参数:

binary - 二进制

close

void close()

关闭