org.voovan.http.websocket

Class WebSocketSession

java.lang.Object

org.voovan.tools.collection.Attributes

org.voovan.http.websocket.WebSocketSession

public class WebSocketSession
extends Attributes

WebSocket 会话对象

Constructor Summary

Constructors

Constructor and Description
WebSocketSession(IoSession socketSession, WebSocketRouter webSocketRouter, WebSocketType webSocketType) 构造函数

Method Summary

Modifier and Type	Method and Description
void	close() 关闭 WebSocket
HttpSession	getHttpSession() 获取 Http 的 session
String	getLocation() 获取WebSocket的地址
String	getRemoteAddress() 获取对端连接的 IP
int	getRemotePort() 获取对端连接的端口
protected IoSession	getSocketSession()
WebSocketRouter	getWebSocketRouter() 获取 WebSocket 路由处理对象
boolean	isConnected() 判断连接状态
void	send(Object obj) 发送 websocket 消息
protected void	send(WebSocketFrame webSocketFrame) 发送 websocket 帧
void	sendBinary(Object obj) 发送 websocket 消息二进制消息
void	setSocketSession(IoSession socketSession)
void	setWebSocketRouter(WebSocketRouter webSocketRouter) 设置获取WebSocket 路由处理对象

Methods inherited from class org.voovan.tools.collection.Attributes

attributes, clearAttribute, containAttribute, getAttribute, isModifyed, removeAttribute, setAttribute, setModifyed

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketSession

public WebSocketSession(IoSession socketSession,
                        WebSocketRouter webSocketRouter,
                        WebSocketType webSocketType)

构造函数

Parameters:

socketSession - Socket 会话

webSocketRouter - WebSocket 路由处理对象

webSocketType - WebSocket类型

Method Detail

getLocation

public String getLocation()

获取WebSocket的地址

Returns:

WebSocket的地址

getHttpSession

public HttpSession getHttpSession()

获取 Http 的 session

Returns:

HttpSession对象

getRemoteAddress

public String getRemoteAddress()

获取对端连接的 IP

Returns:

对端连接的 IP

getRemotePort

public int getRemotePort()

获取对端连接的端口

Returns:

对端连接的端口

getWebSocketRouter

public WebSocketRouter getWebSocketRouter()

获取 WebSocket 路由处理对象

Returns:

WebSocket 路由处理对象

setWebSocketRouter

public void setWebSocketRouter(WebSocketRouter webSocketRouter)

设置获取WebSocket 路由处理对象

Parameters:

webSocketRouter - WebSocket 路由处理对象

send

public void send(Object obj)
          throws SendMessageException,
                 WebSocketFilterException

发送 websocket 消息

Parameters:

obj - 消息对象

Throws:

SendMessageException - 发送异常

WebSocketFilterException - WebSocket过滤器异常

sendBinary

public void sendBinary(Object obj)
                throws SendMessageException,
                       WebSocketFilterException

发送 websocket 消息二进制消息

Parameters:

obj - 消息对象

Throws:

SendMessageException - 发送异常

WebSocketFilterException - WebSocket过滤器异常

send

protected void send(WebSocketFrame webSocketFrame)
             throws SendMessageException

发送 websocket 帧

Parameters:

webSocketFrame - 帧

Throws:

SendMessageException - 发送异常

isConnected

public boolean isConnected()

判断连接状态

Returns:

true: 连接状态, false: 断开状态

close

public void close()

关闭 WebSocket

getSocketSession

protected IoSession getSocketSession()

setSocketSession

public void setSocketSession(IoSession socketSession)