Uses of Class
org.springframework.web.socket.CloseStatus

Packages that use CloseStatus

Package	Description
org.springframework.web.socket	Common abstractions and Spring configuration support for WebSocket applications.
org.springframework.web.socket.adapter	Classes adapting Spring's WebSocket API to and from WebSocket providers.
org.springframework.web.socket.adapter.jetty	Adapter classes for the Jetty WebSocket API.
org.springframework.web.socket.adapter.standard	Adapter classes for the standard Jakarta WebSocket API.
org.springframework.web.socket.handler	Convenient WebSocketHandler implementations and decorators.
org.springframework.web.socket.messaging	WebSocket integration for Spring's messaging module.
org.springframework.web.socket.sockjs.client	SockJS client implementation of WebSocketClient.
org.springframework.web.socket.sockjs.transport.handler	TransportHandler implementation classes as well as a concrete SockJsService.
org.springframework.web.socket.sockjs.transport.session	SockJS specific implementations of WebSocketSession.

Uses of CloseStatus in org.springframework.web.socket

Fields in org.springframework.web.socket declared as CloseStatus

Modifier and Type	Field	Description
static final CloseStatus	CloseStatus.BAD_DATA	"1007 indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (for example, non-UTF-8 [RFC3629] data within a text message)."
static final CloseStatus	CloseStatus.GOING_AWAY	"1001 indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page."
static final CloseStatus	CloseStatus.NO_CLOSE_FRAME	"1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
static final CloseStatus	CloseStatus.NO_STATUS_CODE	"1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
static final CloseStatus	CloseStatus.NORMAL	"1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled."
static final CloseStatus	CloseStatus.NOT_ACCEPTABLE	"1003 indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (for example, an endpoint that understands only text data MAY send this if it receives a binary message)."
static final CloseStatus	CloseStatus.POLICY_VIOLATION	"1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy.
static final CloseStatus	CloseStatus.PROTOCOL_ERROR	"1002 indicates that an endpoint is terminating the connection due to a protocol error."
static final CloseStatus	CloseStatus.REQUIRED_EXTENSION	"1010 indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake.
static final CloseStatus	CloseStatus.SERVER_ERROR	"1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request."
static final CloseStatus	CloseStatus.SERVICE_OVERLOAD	"1013 indicates that the service is experiencing overload.
static final CloseStatus	CloseStatus.SERVICE_RESTARTED	"1012 indicates that the service is restarted.
static final CloseStatus	CloseStatus.SESSION_NOT_RELIABLE	A status code for use within the framework that indicates a session has become unreliable (for example, timed out while sending a message) and extra care should be exercised, for example, avoid sending any further data to the client that may be done during normal shutdown.
static final CloseStatus	CloseStatus.TLS_HANDSHAKE_FAILURE	"1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
static final CloseStatus	CloseStatus.TOO_BIG_TO_PROCESS	"1009 indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process."

Methods in org.springframework.web.socket that return CloseStatus

Modifier and Type	Method	Description
CloseStatus	CloseStatus.withReason(String reason)	Create a new CloseStatus from this one with the specified reason.

Methods in org.springframework.web.socket with parameters of type CloseStatus

Modifier and Type	Method	Description
void	WebSocketHandler.afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)	Invoked after the WebSocket connection has been closed by either side, or after a transport error has occurred.
void	WebSocketSession.close(CloseStatus status)	Close the WebSocket connection with the given close status.
boolean	CloseStatus.equalsCode(CloseStatus other)

Uses of CloseStatus in org.springframework.web.socket.adapter

Methods in org.springframework.web.socket.adapter with parameters of type CloseStatus

Modifier and Type	Method	Description
final void	AbstractWebSocketSession.close(CloseStatus status)
protected abstract void	AbstractWebSocketSession.closeInternal(CloseStatus status)

Uses of CloseStatus in org.springframework.web.socket.adapter.jetty

Methods in org.springframework.web.socket.adapter.jetty with parameters of type CloseStatus

Modifier and Type	Method	Description
protected void	JettyWebSocketSession.closeInternal(CloseStatus status)

Uses of CloseStatus in org.springframework.web.socket.adapter.standard

Methods in org.springframework.web.socket.adapter.standard with parameters of type CloseStatus

Modifier and Type	Method	Description
protected void	StandardWebSocketSession.closeInternal(CloseStatus status)

Uses of CloseStatus in org.springframework.web.socket.handler

Methods in org.springframework.web.socket.handler that return CloseStatus

Modifier and Type	Method	Description
CloseStatus	SessionLimitExceededException.getStatus()

Methods in org.springframework.web.socket.handler with parameters of type CloseStatus

Modifier and Type	Method	Description
void	AbstractWebSocketHandler.afterConnectionClosed(WebSocketSession session, CloseStatus status)
void	ExceptionWebSocketHandlerDecorator.afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)
void	LoggingWebSocketHandlerDecorator.afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)
void	PerConnectionWebSocketHandler.afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)
void	WebSocketHandlerDecorator.afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)
void	ConcurrentWebSocketSessionDecorator.close(CloseStatus status)
void	WebSocketSessionDecorator.close(CloseStatus status)

Constructors in org.springframework.web.socket.handler with parameters of type CloseStatus

Modifier	Constructor	Description
	SessionLimitExceededException(String message, @Nullable CloseStatus status)

Uses of CloseStatus in org.springframework.web.socket.messaging

Methods in org.springframework.web.socket.messaging that return CloseStatus

Modifier and Type	Method	Description
CloseStatus	SessionDisconnectEvent.getCloseStatus()	Return the status with which the session was closed.

Methods in org.springframework.web.socket.messaging with parameters of type CloseStatus

Modifier and Type	Method	Description
void	SubProtocolWebSocketHandler.afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)
void	StompSubProtocolHandler.afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel)
void	SubProtocolHandler.afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel)	Invoked after a WebSocketSession has ended.

Constructors in org.springframework.web.socket.messaging with parameters of type CloseStatus

Modifier	Constructor	Description
	SessionDisconnectEvent(Object source, Message<byte[]> message, String sessionId, CloseStatus closeStatus)	Create a new SessionDisconnectEvent.
	SessionDisconnectEvent(Object source, Message<byte[]> message, String sessionId, CloseStatus closeStatus, @Nullable Principal user)	Create a new SessionDisconnectEvent.

Uses of CloseStatus in org.springframework.web.socket.sockjs.client

Methods in org.springframework.web.socket.sockjs.client with parameters of type CloseStatus

Modifier and Type	Method	Description
void	AbstractClientSockJsSession.afterTransportClosed(@Nullable CloseStatus closeStatus)
final void	AbstractClientSockJsSession.close(CloseStatus status)
protected void	AbstractClientSockJsSession.closeInternal(CloseStatus status)
protected abstract void	AbstractClientSockJsSession.disconnect(CloseStatus status)
protected void	WebSocketClientSockJsSession.disconnect(CloseStatus status)
protected void	XhrClientSockJsSession.disconnect(CloseStatus status)

Uses of CloseStatus in org.springframework.web.socket.sockjs.transport.handler

Methods in org.springframework.web.socket.sockjs.transport.handler with parameters of type CloseStatus

Modifier and Type	Method	Description
void	SockJsWebSocketHandler.afterConnectionClosed(WebSocketSession wsSession, CloseStatus status)

Uses of CloseStatus in org.springframework.web.socket.sockjs.transport.session

Methods in org.springframework.web.socket.sockjs.transport.session with parameters of type CloseStatus

Modifier and Type	Method	Description
final void	AbstractSockJsSession.close(CloseStatus status)	Performs cleanup and notify the WebSocketHandler.
final void	AbstractSockJsSession.delegateConnectionClosed(CloseStatus status)	Invoked when the underlying connection is closed.
protected void	AbstractHttpSockJsSession.disconnect(CloseStatus status)
protected abstract void	AbstractSockJsSession.disconnect(CloseStatus status)	Actually close the underlying WebSocket session or in the case of HTTP transports complete the underlying request.
protected void	WebSocketServerSockJsSession.disconnect(CloseStatus status)
void	AbstractSockJsSession.tryCloseWithSockJsTransportError(Throwable error, CloseStatus closeStatus)	Close due to error arising from SockJS transport handling.