WebSocketSession类 参考

WebSocketSession 的协作图:

Public 成员函数

详细描述

WebSocket会话类，用于管理WebSocket连接的会话信息 提供了获取客户端信息、发送消息、管理会话数据等功能

在文件 WebSocketSession.x 第 5 行定义.

构造及析构函数说明

WebSocketSession()

WebSocketSession

(

)

构造函数，初始化WebSocket会话

成员函数说明

close()

bool close

(

)

finalize()

void finalize

(

)

getArg()

String getArg

(

String

)

获取指定名称的参数值

参数

name

参数名称

返回

非空指针，返回对应的参数值

getArgKeys()

String [] getArgKeys

(

)

获取所有参数的名称键

返回

非空指针，返回参数名称字符串数组

getArgs()

String [] getArgs

(

String

)

获取指定名称的参数值数组

参数

name

参数名称

返回

非空指针，返回对应的参数值数组

getClientAddress()

InetAddress getClientAddress

(

)

获取客户端的IP地址

返回

非空指针，返回客户端的InetAddress对象

getCookie()

String getCookie

(

String

)

获取指定名称的Cookie值

参数

cookieName

Cookie名称

返回

非空指针，返回对应的Cookie值

getHeader()

String getHeader

(

String

)

获取指定名称的HTTP头信息

参数

headerName

头名称

返回

非空指针，返回对应的头信息字符串

getHost()

String getHost

(

)

获取主机地址

返回

非空指针，返回主机地址字符串

getId()

long getId

(

)

获取会话ID

返回

会话ID的长整型值

getMethod()

String getMethod

(

)

获取请求方法

返回

非空指针，返回请求方法字符串

getQueryString()

String getQueryString

(

)

getScheme()

String getScheme

(

)

getServerName()

String getServerName

(

)

getServerPort()

int getServerPort

(

)

getSession()

Object getSession

(

String

)

获取指定名称的会话属性

参数

name

属性名称

返回

非空指针，返回对应的会话属性值

getUrl()

String getUrl

(

)

获取当前请求的URL

返回

非空指针，返回URL字符串

getUserData()

Object getUserData

(

)

获取用户自定义数据

返回

非空指针，返回用户数据对象

getWebsite()

Website getWebsite

(

)

获取网站对象

返回

非空指针，返回Website对象

isOpened()

bool isOpened

(

)

sendBinary() [1/2]

bool sendBinary

(

byte

[]

)

sendBinary() [2/2]

bool sendBinary	(	byte	[],
		int	,
		int
	)

sendText()

bool sendText

(

String

)

发送文本消息

参数

text

要发送的文本内容

返回

发送成功返回true，否则返回false

setSession()

void setSession	(	String	,
			Object
	)

设置会话属性

参数

name	属性名称
value	属性值

setUserData()

void setUserData

(

Object

)

设置用户自定义数据

参数

data

用户数据对象