Package akka.http.javadsl.model.ws
Interface WebSocketUpgradeResponse
-
public interface WebSocketUpgradeResponseRepresents an upgrade response for a WebSocket upgrade request. Can either be valid, in which case thechosenSubprotocolmethod is valid, or if invalid, theinvalidationReasonmethod can be used to find out why the upgrade failed.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Optional<java.lang.String>chosenSubprotocol()If valid, returnsSome(subprotocol)(if any was requested), orNoneif none was chosen or offered.java.lang.StringinvalidationReason()If invalid, the reason why the server's upgrade response could not be accepted.booleanisValid()HttpResponseresponse()Returns the response object as received from the server for further inspection.
-
-
-
Method Detail
-
isValid
boolean isValid()
-
response
HttpResponse response()
Returns the response object as received from the server for further inspection.- Returns:
- (undocumented)
-
chosenSubprotocol
java.util.Optional<java.lang.String> chosenSubprotocol()
If valid, returnsSome(subprotocol)(if any was requested), orNoneif none was chosen or offered.- Returns:
- (undocumented)
-
invalidationReason
java.lang.String invalidationReason()
If invalid, the reason why the server's upgrade response could not be accepted.- Returns:
- (undocumented)
-
-