Package jakarta.websocket
Class CloseReason
- java.lang.Object
-
- jakarta.websocket.CloseReason
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CloseReason.CloseCode
A marker interface for the close codes.static class
CloseReason.CloseCodes
An Enumeration of status codes for a web socket close that are defined in the specification.
-
Constructor Summary
Constructors Constructor Description CloseReason(CloseReason.CloseCode closeCode, String reasonPhrase)
Creates a reason for closing a web socket connection with the given code and reason phrase.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CloseReason.CloseCode
getCloseCode()
The Close code associated with this CloseReason.String
getReasonPhrase()
The reason phrase associated with this CloseReason.String
toString()
Converts the CloseReason to a debug-friendly string.
-
-
-
Constructor Detail
-
CloseReason
public CloseReason(CloseReason.CloseCode closeCode, String reasonPhrase)
Creates a reason for closing a web socket connection with the given code and reason phrase.- Parameters:
closeCode
- the close code, may not benull
reasonPhrase
- the reason phrase, may benull
.
-
-
Method Detail
-
getCloseCode
public CloseReason.CloseCode getCloseCode()
The Close code associated with this CloseReason.- Returns:
- the close code.
-
getReasonPhrase
public String getReasonPhrase()
The reason phrase associated with this CloseReason.- Returns:
- the reason phrase. If there is no reason phrase, this returns the empty string
-
-