com.github.netty.protocol.servlet.websocket

类 WebSocketSession

java.lang.Object

com.github.netty.protocol.servlet.websocket.WebSocketSession

所有已实现的接口:

Closeable, AutoCloseable, javax.websocket.Session

public class WebSocketSession
extends Object
implements javax.websocket.Session

Websocket session

作者:

wangzihao 2018/10/13/013

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	WebSocketSession.EncoderEntry
static class	WebSocketSession.SimpleFuture
static class	WebSocketSession.State

字段概要

字段

限定符和类型	字段和说明
static io.netty.util.AttributeKey<WebSocketSession>	CHANNEL_ATTR_KEY_SESSION

构造器概要

构造器

构造器和说明

WebSocketSession(io.netty.channel.Channel channel, WebSocketServerContainer webSocketContainer, WebSocketServerHandshaker13Extension webSocketServerHandshaker, Map<String,List<String>> requestParameterMap, String queryString, Principal userPrincipal, String httpSessionId, List<javax.websocket.Extension> negotiatedExtensions, Map<String,String> pathParameters, javax.websocket.Endpoint localEndpoint, javax.websocket.server.ServerEndpointConfig serverEndpointConfig)

方法概要

限定符和类型	方法和说明
<T> void	addMessageHandler(Class<T> clazz, javax.websocket.MessageHandler.Partial<T> handler)
<T> void	addMessageHandler(Class<T> clazz, javax.websocket.MessageHandler.Whole<T> handler)
void	addMessageHandler(javax.websocket.MessageHandler handler)
void	close()
void	close(javax.websocket.CloseReason closeReason)
javax.websocket.RemoteEndpoint.Async	getAsyncRemote()
javax.websocket.RemoteEndpoint.Basic	getBasicRemote()
javax.websocket.WebSocketContainer	getContainer()
String	getId()
int	getMaxBinaryMessageBufferSize()
long	getMaxIdleTimeout()
int	getMaxTextMessageBufferSize()
Set<javax.websocket.MessageHandler>	getMessageHandlers()
List<javax.websocket.Extension>	getNegotiatedExtensions()
String	getNegotiatedSubprotocol()
Set<javax.websocket.Session>	getOpenSessions()
Map<String,String>	getPathParameters()
String	getProtocolVersion()
String	getQueryString()
Map<String,List<String>>	getRequestParameterMap()
URI	getRequestURI()
static WebSocketSession	getSession(io.netty.channel.Channel channel) Get httpSession from the properties bound in the pipe
Principal	getUserPrincipal()
Map<String,Object>	getUserProperties()
WebSocketServerHandshaker13Extension	getWebSocketServerHandshaker()
static boolean	isChannelActive(io.netty.channel.Channel channel) Whether the pipe is active
boolean	isOpen()
boolean	isSecure()
void	removeMessageHandler(javax.websocket.MessageHandler listener)
Future<Void>	sendObjectImpl(Object obj, javax.websocket.SendHandler completion)
void	setMaxBinaryMessageBufferSize(int max)
void	setMaxIdleTimeout(long timeout)
void	setMaxTextMessageBufferSize(int max)
static void	setSession(io.netty.channel.Channel channel, WebSocketSession websocketSession) Bind WebsocketSession to the pipe property

从类继承的方法 java.lang.Object

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

字段详细资料

CHANNEL_ATTR_KEY_SESSION

public static final io.netty.util.AttributeKey<WebSocketSession> CHANNEL_ATTR_KEY_SESSION

构造器详细资料

WebSocketSession

public WebSocketSession(io.netty.channel.Channel channel,
                        WebSocketServerContainer webSocketContainer,
                        WebSocketServerHandshaker13Extension webSocketServerHandshaker,
                        Map<String,List<String>> requestParameterMap,
                        String queryString,
                        Principal userPrincipal,
                        String httpSessionId,
                        List<javax.websocket.Extension> negotiatedExtensions,
                        Map<String,String> pathParameters,
                        javax.websocket.Endpoint localEndpoint,
                        javax.websocket.server.ServerEndpointConfig serverEndpointConfig)
                 throws javax.websocket.DeploymentException

抛出:

javax.websocket.DeploymentException

方法详细资料

getWebSocketServerHandshaker

public WebSocketServerHandshaker13Extension getWebSocketServerHandshaker()

getSession

public static WebSocketSession getSession(io.netty.channel.Channel channel)

Get httpSession from the properties bound in the pipe

参数:

channel - channel

返回:

WebSocketSession

setSession

public static void setSession(io.netty.channel.Channel channel,
                              WebSocketSession websocketSession)

Bind WebsocketSession to the pipe property

参数:

websocketSession - websocketSession

channel - channel

isChannelActive

public static boolean isChannelActive(io.netty.channel.Channel channel)

Whether the pipe is active

参数:

channel - channel

返回:

boolean isChannelActive

getContainer

public javax.websocket.WebSocketContainer getContainer()

指定者:

getContainer 在接口中 javax.websocket.Session

getMessageHandlers

public Set<javax.websocket.MessageHandler> getMessageHandlers()

指定者:

getMessageHandlers 在接口中 javax.websocket.Session

removeMessageHandler

public void removeMessageHandler(javax.websocket.MessageHandler listener)

指定者:

removeMessageHandler 在接口中 javax.websocket.Session

getProtocolVersion

public String getProtocolVersion()

指定者:

getProtocolVersion 在接口中 javax.websocket.Session

getNegotiatedSubprotocol

public String getNegotiatedSubprotocol()

指定者:

getNegotiatedSubprotocol 在接口中 javax.websocket.Session

getNegotiatedExtensions

public List<javax.websocket.Extension> getNegotiatedExtensions()

指定者:

getNegotiatedExtensions 在接口中 javax.websocket.Session

isSecure

public boolean isSecure()

指定者:

isSecure 在接口中 javax.websocket.Session

isOpen

public boolean isOpen()

指定者:

isOpen 在接口中 javax.websocket.Session

getMaxIdleTimeout

public long getMaxIdleTimeout()

指定者:

getMaxIdleTimeout 在接口中 javax.websocket.Session

setMaxIdleTimeout

public void setMaxIdleTimeout(long timeout)

指定者:

setMaxIdleTimeout 在接口中 javax.websocket.Session

setMaxBinaryMessageBufferSize

public void setMaxBinaryMessageBufferSize(int max)

指定者:

setMaxBinaryMessageBufferSize 在接口中 javax.websocket.Session

getMaxBinaryMessageBufferSize

public int getMaxBinaryMessageBufferSize()

指定者:

getMaxBinaryMessageBufferSize 在接口中 javax.websocket.Session

setMaxTextMessageBufferSize

public void setMaxTextMessageBufferSize(int max)

指定者:

setMaxTextMessageBufferSize 在接口中 javax.websocket.Session

getMaxTextMessageBufferSize

public int getMaxTextMessageBufferSize()

指定者:

getMaxTextMessageBufferSize 在接口中 javax.websocket.Session

getAsyncRemote

public javax.websocket.RemoteEndpoint.Async getAsyncRemote()

指定者:

getAsyncRemote 在接口中 javax.websocket.Session

getBasicRemote

public javax.websocket.RemoteEndpoint.Basic getBasicRemote()

指定者:

getBasicRemote 在接口中 javax.websocket.Session

getId

public String getId()

指定者:

getId 在接口中 javax.websocket.Session

close

public void close()
           throws IOException

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

指定者:

close 在接口中 javax.websocket.Session

抛出:

IOException

close

public void close(javax.websocket.CloseReason closeReason)
           throws IOException

指定者:

close 在接口中 javax.websocket.Session

抛出:

IOException

getRequestURI

public URI getRequestURI()

指定者:

getRequestURI 在接口中 javax.websocket.Session

getRequestParameterMap

public Map<String,List<String>> getRequestParameterMap()

指定者:

getRequestParameterMap 在接口中 javax.websocket.Session

getQueryString

public String getQueryString()

指定者:

getQueryString 在接口中 javax.websocket.Session

getPathParameters

public Map<String,String> getPathParameters()

指定者:

getPathParameters 在接口中 javax.websocket.Session

getUserProperties

public Map<String,Object> getUserProperties()

指定者:

getUserProperties 在接口中 javax.websocket.Session

getUserPrincipal

public Principal getUserPrincipal()

指定者:

getUserPrincipal 在接口中 javax.websocket.Session

getOpenSessions

public Set<javax.websocket.Session> getOpenSessions()

指定者:

getOpenSessions 在接口中 javax.websocket.Session

addMessageHandler

public void addMessageHandler(javax.websocket.MessageHandler handler)
                       throws IllegalStateException

指定者:

addMessageHandler 在接口中 javax.websocket.Session

抛出:

IllegalStateException

addMessageHandler

public <T> void addMessageHandler(Class<T> clazz,
                                  javax.websocket.MessageHandler.Partial<T> handler)
                           throws IllegalStateException

指定者:

addMessageHandler 在接口中 javax.websocket.Session

抛出:

IllegalStateException

addMessageHandler

public <T> void addMessageHandler(Class<T> clazz,
                                  javax.websocket.MessageHandler.Whole<T> handler)
                           throws IllegalStateException

指定者:

addMessageHandler 在接口中 javax.websocket.Session

抛出:

IllegalStateException

sendObjectImpl

public Future<Void> sendObjectImpl(Object obj,
                                   javax.websocket.SendHandler completion)