接口的使用
org.springframework.web.socket.WebSocketHandler
使用WebSocketHandler的程序包 程序包 说明 org.springframework.web.socket.adapter.jetty Adapter classes for the Jetty WebSocket API.org.springframework.web.socket.adapter.standard Adapter classes for the standard Java WebSocket API.org.springframework.web.socket.client Client-side abstractions for WebSocket applications.org.springframework.web.socket.client.jetty Client-side support for the Jetty WebSocket API.org.springframework.web.socket.client.standard Client-side classes for use with standard Java WebSocket endpoints.org.springframework.web.socket.config.annotation Support for annotation-based WebSocket setup in configuration classes.org.springframework.web.socket.handler ConvenientWebSocketHandlerimplementations and decorators.org.springframework.web.socket.messaging WebSocket integration for Spring's messaging module.org.springframework.web.socket.server Server-side abstractions for WebSocket interactions.org.springframework.web.socket.server.jetty Server-side support for the Jetty 9+ WebSocket API.org.springframework.web.socket.server.standard Server-side classes for use with standard JSR-356 WebSocket endpoints.org.springframework.web.socket.server.support Server-side support classes including container-specific strategies for upgrading a request.org.springframework.web.socket.sockjs Top-level SockJS types.org.springframework.web.socket.sockjs.client SockJS client implementation ofWebSocketClient.org.springframework.web.socket.sockjs.support Support classes for SockJS including anAbstractSockJsServiceimplementation.org.springframework.web.socket.sockjs.transport Server-side support for SockJS transports includingTransportHandlerimplementations for processing incoming requests, theirsessioncounterparts for sending messages over the various transports, andDefaultSockJsService.org.springframework.web.socket.sockjs.transport.handler TransportHandlerimplementation classes as well as a concreteSockJsService.org.springframework.web.socket.sockjs.transport.session SockJS specific implementations ofWebSocketSession.org.springframework.web.socket.adapter.jetty中WebSocketHandler的使用
参数类型为WebSocketHandler的org.springframework.web.socket.adapter.jetty中的构造器 构造器 说明 JettyWebSocketHandlerAdapter(WebSocketHandler webSocketHandler, JettyWebSocketSession wsSession)org.springframework.web.socket.adapter.standard中WebSocketHandler的使用
参数类型为WebSocketHandler的org.springframework.web.socket.adapter.standard中的构造器 构造器 说明 StandardWebSocketHandlerAdapter(WebSocketHandler handler, StandardWebSocketSession wsSession)org.springframework.web.socket.client中WebSocketHandler的使用
返回WebSocketHandler的org.springframework.web.socket.client中的方法 修饰符和类型 方法 说明 protected WebSocketHandlerWebSocketConnectionManager. decorateWebSocketHandler(WebSocketHandler handler)Decorate the WebSocketHandler provided to the class constructor.参数类型为WebSocketHandler的org.springframework.web.socket.client中的方法 修饰符和类型 方法 说明 protected WebSocketHandlerWebSocketConnectionManager. decorateWebSocketHandler(WebSocketHandler handler)Decorate the WebSocketHandler provided to the class constructor.ListenableFuture<WebSocketSession>AbstractWebSocketClient. doHandshake(WebSocketHandler webSocketHandler, String uriTemplate, Object... uriVars)ListenableFuture<WebSocketSession>AbstractWebSocketClient. doHandshake(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URI uri)ListenableFuture<WebSocketSession>WebSocketClient. doHandshake(WebSocketHandler webSocketHandler, String uriTemplate, Object... uriVariables)ListenableFuture<WebSocketSession>WebSocketClient. doHandshake(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URI uri)protected abstract ListenableFuture<WebSocketSession>AbstractWebSocketClient. doHandshakeInternal(WebSocketHandler webSocketHandler, HttpHeaders headers, URI uri, List<String> subProtocols, List<WebSocketExtension> extensions, Map<String,Object> attributes)Perform the actual handshake to establish a connection to the server.参数类型为WebSocketHandler的org.springframework.web.socket.client中的构造器 构造器 说明 WebSocketConnectionManager(WebSocketClient client, WebSocketHandler webSocketHandler, String uriTemplate, Object... uriVariables)org.springframework.web.socket.client.jetty中WebSocketHandler的使用
参数类型为WebSocketHandler的org.springframework.web.socket.client.jetty中的方法 修饰符和类型 方法 说明 ListenableFuture<WebSocketSession>JettyWebSocketClient. doHandshake(WebSocketHandler webSocketHandler, String uriTemplate, Object... uriVars)ListenableFuture<WebSocketSession>JettyWebSocketClient. doHandshakeInternal(WebSocketHandler wsHandler, HttpHeaders headers, URI uri, List<String> protocols, List<WebSocketExtension> extensions, Map<String,Object> attributes)org.springframework.web.socket.client.standard中WebSocketHandler的使用
参数类型为WebSocketHandler的org.springframework.web.socket.client.standard中的方法 修饰符和类型 方法 说明 protected ListenableFuture<WebSocketSession>StandardWebSocketClient. doHandshakeInternal(WebSocketHandler webSocketHandler, HttpHeaders headers, URI uri, List<String> protocols, List<WebSocketExtension> extensions, Map<String,Object> attributes)org.springframework.web.socket.config.annotation中WebSocketHandler的使用
返回WebSocketHandler的org.springframework.web.socket.config.annotation中的方法 修饰符和类型 方法 说明 protected WebSocketHandlerWebSocketMessageBrokerConfigurationSupport. decorateWebSocketHandler(WebSocketHandler handler)WebSocketHandlerWebSocketMessageBrokerConfigurationSupport. subProtocolWebSocketHandler()参数类型为WebSocketHandler的org.springframework.web.socket.config.annotation中的方法 修饰符和类型 方法 说明 WebSocketHandlerRegistrationAbstractWebSocketHandlerRegistration. addHandler(WebSocketHandler handler, String... paths)WebSocketHandlerRegistrationServletWebSocketHandlerRegistry. addHandler(WebSocketHandler handler, String... paths)WebSocketHandlerRegistrationWebSocketHandlerRegistration. addHandler(WebSocketHandler handler, String... paths)Add more handlers that will share the same configuration (interceptors, SockJS config, etc).WebSocketHandlerRegistrationWebSocketHandlerRegistry. addHandler(WebSocketHandler webSocketHandler, String... paths)Configure a WebSocketHandler at the specified URL paths.protected abstract voidAbstractWebSocketHandlerRegistration. addSockJsServiceMapping(M mappings, SockJsService sockJsService, WebSocketHandler handler, String pathPattern)protected voidServletWebSocketHandlerRegistration. addSockJsServiceMapping(MultiValueMap<HttpRequestHandler,String> mappings, SockJsService sockJsService, WebSocketHandler handler, String pathPattern)protected abstract voidAbstractWebSocketHandlerRegistration. addWebSocketHandlerMapping(M mappings, WebSocketHandler wsHandler, HandshakeHandler handshakeHandler, HandshakeInterceptor[] interceptors, String path)protected voidServletWebSocketHandlerRegistration. addWebSocketHandlerMapping(MultiValueMap<HttpRequestHandler,String> mappings, WebSocketHandler webSocketHandler, HandshakeHandler handshakeHandler, HandshakeInterceptor[] interceptors, String path)protected WebSocketHandlerWebSocketMessageBrokerConfigurationSupport. decorateWebSocketHandler(WebSocketHandler handler)参数类型为WebSocketHandler的org.springframework.web.socket.config.annotation中的构造器 构造器 说明 WebMvcStompEndpointRegistry(WebSocketHandler webSocketHandler, WebSocketTransportRegistration transportRegistration, TaskScheduler defaultSockJsTaskScheduler)WebMvcStompWebSocketEndpointRegistration(String[] paths, WebSocketHandler webSocketHandler, TaskScheduler sockJsTaskScheduler)org.springframework.web.socket.handler中WebSocketHandler的使用
实现WebSocketHandler的org.springframework.web.socket.handler中的类 修饰符和类型 类 说明 classAbstractWebSocketHandlerA convenient base class forWebSocketHandlerimplementation with empty methods.classBinaryWebSocketHandlerA convenient base class forWebSocketHandlerimplementations that process binary messages only.classExceptionWebSocketHandlerDecoratorAn exception handlingWebSocketHandlerDecorator.classLoggingWebSocketHandlerDecoratorAWebSocketHandlerDecoratorthat adds logging to WebSocket lifecycle events.classPerConnectionWebSocketHandlerAWebSocketHandlerthat initializes and destroys aWebSocketHandlerinstance for each WebSocket connection and delegates all other methods to it.classTextWebSocketHandlerA convenient base class forWebSocketHandlerimplementations that process text messages only.classWebSocketHandlerDecoratorWraps anotherWebSocketHandlerinstance and delegates to it.返回WebSocketHandler的org.springframework.web.socket.handler中的方法 修饰符和类型 方法 说明 WebSocketHandlerWebSocketHandlerDecoratorFactory. decorate(WebSocketHandler handler)Decorate the given WebSocketHandler.WebSocketHandlerWebSocketHandlerDecorator. getDelegate()WebSocketHandlerWebSocketHandlerDecorator. getLastHandler()static WebSocketHandlerWebSocketHandlerDecorator. unwrap(WebSocketHandler handler)参数类型为WebSocketHandler的org.springframework.web.socket.handler中的方法 修饰符和类型 方法 说明 WebSocketHandlerWebSocketHandlerDecoratorFactory. decorate(WebSocketHandler handler)Decorate the given WebSocketHandler.static WebSocketHandlerWebSocketHandlerDecorator. unwrap(WebSocketHandler handler)参数类型为WebSocketHandler的org.springframework.web.socket.handler中的构造器 构造器 说明 ExceptionWebSocketHandlerDecorator(WebSocketHandler delegate)LoggingWebSocketHandlerDecorator(WebSocketHandler delegate)WebSocketHandlerDecorator(WebSocketHandler delegate)类型变量类型为WebSocketHandler的org.springframework.web.socket.handler中的构造器参数 构造器 说明 PerConnectionWebSocketHandler(Class<? extends WebSocketHandler> handlerType)PerConnectionWebSocketHandler(Class<? extends WebSocketHandler> handlerType, boolean supportsPartialMessages)org.springframework.web.socket.messaging中WebSocketHandler的使用
实现WebSocketHandler的org.springframework.web.socket.messaging中的类 修饰符和类型 类 说明 classSubProtocolWebSocketHandlerAn implementation ofWebSocketHandlerthat delegates incoming WebSocket messages to aSubProtocolHandleralong with aMessageChannelto which the sub-protocol handler can send messages from WebSocket clients to the application.org.springframework.web.socket.server中WebSocketHandler的使用
参数类型为WebSocketHandler的org.springframework.web.socket.server中的方法 修饰符和类型 方法 说明 voidHandshakeInterceptor. afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception exception)Invoked after the handshake is done.booleanHandshakeInterceptor. beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String,Object> attributes)Invoked before the handshake is processed.booleanHandshakeHandler. doHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String,Object> attributes)Initiate the handshake.voidRequestUpgradeStrategy. upgrade(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<WebSocketExtension> selectedExtensions, Principal user, WebSocketHandler wsHandler, Map<String,Object> attributes)Perform runtime specific steps to complete the upgrade.org.springframework.web.socket.server.jetty中WebSocketHandler的使用
参数类型为WebSocketHandler的org.springframework.web.socket.server.jetty中的方法 修饰符和类型 方法 说明 voidJettyRequestUpgradeStrategy. upgrade(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<WebSocketExtension> selectedExtensions, Principal user, WebSocketHandler wsHandler, Map<String,Object> attributes)org.springframework.web.socket.server.standard中WebSocketHandler的使用
参数类型为WebSocketHandler的org.springframework.web.socket.server.standard中的方法 修饰符和类型 方法 说明 voidAbstractStandardUpgradeStrategy. upgrade(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<WebSocketExtension> selectedExtensions, Principal user, WebSocketHandler wsHandler, Map<String,Object> attrs)org.springframework.web.socket.server.support中WebSocketHandler的使用
返回WebSocketHandler的org.springframework.web.socket.server.support中的方法 修饰符和类型 方法 说明 protected WebSocketHandlerWebSocketHttpRequestHandler. decorate(WebSocketHandler handler)Decorate theWebSocketHandlerpassed into the constructor.WebSocketHandlerWebSocketHttpRequestHandler. getWebSocketHandler()Return the WebSocketHandler.参数类型为WebSocketHandler的org.springframework.web.socket.server.support中的方法 修饰符和类型 方法 说明 voidHttpSessionHandshakeInterceptor. afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception ex)voidOriginHandshakeInterceptor. afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception exception)booleanHttpSessionHandshakeInterceptor. beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String,Object> attributes)booleanOriginHandshakeInterceptor. beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String,Object> attributes)protected WebSocketHandlerWebSocketHttpRequestHandler. decorate(WebSocketHandler handler)Decorate theWebSocketHandlerpassed into the constructor.protected List<String>AbstractHandshakeHandler. determineHandlerSupportedProtocols(WebSocketHandler handler)Determine the sub-protocols supported by the given WebSocketHandler by checking whether it is an instance ofSubProtocolCapable.protected PrincipalAbstractHandshakeHandler. determineUser(ServerHttpRequest request, WebSocketHandler wsHandler, Map<String,Object> attributes)A method that can be used to associate a user with the WebSocket session in the process of being established.booleanAbstractHandshakeHandler. doHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String,Object> attributes)protected StringAbstractHandshakeHandler. selectProtocol(List<String> requestedProtocols, WebSocketHandler webSocketHandler)Perform the sub-protocol negotiation based on requested and supported sub-protocols.参数类型为WebSocketHandler的org.springframework.web.socket.server.support中的构造器 构造器 说明 HandshakeInterceptorChain(List<HandshakeInterceptor> interceptors, WebSocketHandler wsHandler)WebSocketHttpRequestHandler(WebSocketHandler wsHandler)WebSocketHttpRequestHandler(WebSocketHandler wsHandler, HandshakeHandler handshakeHandler)org.springframework.web.socket.sockjs中WebSocketHandler的使用
参数类型为WebSocketHandler的org.springframework.web.socket.sockjs中的方法 修饰符和类型 方法 说明 voidSockJsService. handleRequest(ServerHttpRequest request, ServerHttpResponse response, String sockJsPath, WebSocketHandler handler)Process a SockJS HTTP request.org.springframework.web.socket.sockjs.client中WebSocketHandler的使用
返回WebSocketHandler的org.springframework.web.socket.sockjs.client中的方法 修饰符和类型 方法 说明 WebSocketHandlerAbstractClientSockJsSession. getWebSocketHandler()参数类型为WebSocketHandler的org.springframework.web.socket.sockjs.client中的构造器 构造器 说明 AbstractClientSockJsSession(TransportRequest request, WebSocketHandler handler, SettableListenableFuture<WebSocketSession> connectFuture)WebSocketClientSockJsSession(TransportRequest request, WebSocketHandler handler, SettableListenableFuture<WebSocketSession> connectFuture)XhrClientSockJsSession(TransportRequest request, WebSocketHandler handler, XhrTransport transport, SettableListenableFuture<WebSocketSession> connectFuture)org.springframework.web.socket.sockjs.support中WebSocketHandler的使用
返回WebSocketHandler的org.springframework.web.socket.sockjs.support中的方法 修饰符和类型 方法 说明 WebSocketHandlerSockJsHttpRequestHandler. getWebSocketHandler()Return theWebSocketHandler.参数类型为WebSocketHandler的org.springframework.web.socket.sockjs.support中的方法 修饰符和类型 方法 说明 protected abstract voidAbstractSockJsService. handleRawWebSocketRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler webSocketHandler)Handle request for raw WebSocket communication, i.e. without any SockJS message framing.voidAbstractSockJsService. handleRequest(ServerHttpRequest request, ServerHttpResponse response, String sockJsPath, WebSocketHandler wsHandler)This method determines the SockJS path and handles SockJS static URLs.protected abstract voidAbstractSockJsService. handleTransportRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler webSocketHandler, String sessionId, String transport)Handle a SockJS session URL (i.e. transport-specific request).参数类型为WebSocketHandler的org.springframework.web.socket.sockjs.support中的构造器 构造器 说明 SockJsHttpRequestHandler(SockJsService sockJsService, WebSocketHandler webSocketHandler)Create a new SockJsHttpRequestHandler.org.springframework.web.socket.sockjs.transport中WebSocketHandler的使用
参数类型为WebSocketHandler的org.springframework.web.socket.sockjs.transport中的方法 修饰符和类型 方法 说明 SockJsSessionSockJsSessionFactory. createSession(String sessionId, WebSocketHandler handler, Map<String,Object> attributes)Create a new SockJS session.protected voidTransportHandlingSockJsService. handleRawWebSocketRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler handler)voidTransportHandler. handleRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler handler, SockJsSession session)Handle the given request and delegate messages to the providedWebSocketHandler.protected voidTransportHandlingSockJsService. handleTransportRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler handler, String sessionId, String transport)org.springframework.web.socket.sockjs.transport.handler中WebSocketHandler的使用
实现WebSocketHandler的org.springframework.web.socket.sockjs.transport.handler中的类 修饰符和类型 类 说明 classSockJsWebSocketHandlerAn implementation ofWebSocketHandlerthat adds SockJS messages frames, sends SockJS heartbeat messages, and delegates lifecycle events and messages to a targetWebSocketHandler.参数类型为WebSocketHandler的org.springframework.web.socket.sockjs.transport.handler中的构造器 构造器 说明 SockJsWebSocketHandler(SockJsServiceConfig serviceConfig, WebSocketHandler webSocketHandler, WebSocketServerSockJsSession sockJsSession)org.springframework.web.socket.sockjs.transport.session中WebSocketHandler的使用
参数类型为WebSocketHandler的org.springframework.web.socket.sockjs.transport.session中的构造器 构造器 说明 AbstractHttpSockJsSession(String id, SockJsServiceConfig config, WebSocketHandler wsHandler, Map<String,Object> attributes)AbstractSockJsSession(String id, SockJsServiceConfig config, WebSocketHandler handler, Map<String,Object> attributes)Create a new instance.PollingSockJsSession(String sessionId, SockJsServiceConfig config, WebSocketHandler wsHandler, Map<String,Object> attributes)StreamingSockJsSession(String sessionId, SockJsServiceConfig config, WebSocketHandler wsHandler, Map<String,Object> attributes)WebSocketServerSockJsSession(String id, SockJsServiceConfig config, WebSocketHandler handler, Map<String,Object> attributes)