Uses of Class
org.springframework.web.reactive.socket.CloseStatus
Package
Description
Abstractions and support classes for reactive WebSocket interactions.
Classes adapting Spring's Reactive WebSocket API to and from WebSocket runtimes.
-
Uses of CloseStatus in org.springframework.web.reactive.socket
Modifier and TypeFieldDescriptionstatic 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 (e.g., 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 (e.g., 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.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."Modifier and TypeMethodDescriptionstatic CloseStatus
Return a constant for the given code, or create a new instance if the code does not match or there is a reason.CloseStatus.withReason
(String reason) Create a newCloseStatus
from this one with the specified reason.Modifier and TypeMethodDescriptionreactor.core.publisher.Mono<CloseStatus>
WebSocketSession.closeStatus()
Provides access to theCloseStatus
with which the session is closed either locally or remotely, or completes empty if the session ended without a status.Modifier and TypeMethodDescriptionreactor.core.publisher.Mono<Void>
WebSocketSession.close
(CloseStatus status) Close the WebSocket session with the given status.boolean
CloseStatus.equalsCode
(CloseStatus other) Deprecated.as of 5.3 in favor of comparing codes directly -
Uses of CloseStatus in org.springframework.web.reactive.socket.adapter
Modifier and TypeMethodDescriptionreactor.core.publisher.Mono<CloseStatus>
AbstractListenerWebSocketSession.closeStatus()
reactor.core.publisher.Mono<CloseStatus>
ReactorNettyWebSocketSession.closeStatus()
Modifier and TypeMethodDescriptionreactor.core.publisher.Mono<Void>
JettyWebSocketSession.close
(CloseStatus status) reactor.core.publisher.Mono<Void>
ReactorNettyWebSocketSession.close
(CloseStatus status) reactor.core.publisher.Mono<Void>
StandardWebSocketSession.close
(CloseStatus status) reactor.core.publisher.Mono<Void>
UndertowWebSocketSession.close
(CloseStatus status)