Package org.apache.pekko.http.javadsl.model.ws

Interface WebSocketUpgradeResponse

public interface WebSocketUpgradeResponse
Represents an upgrade response for a WebSocket upgrade request. Can either be valid, in which case the chosenSubprotocol method is valid, or if invalid, the invalidationReason method can be used to find out why the upgrade failed.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<String>
    chosenSubprotocol()
    If valid, returns Some(subprotocol) (if any was requested), or None if none was chosen or offered.
    String
    invalidationReason()
    If invalid, the reason why the server's upgrade response could not be accepted.
    boolean
    isValid()
     
    HttpResponse
    response()
    Returns the response object as received from the server for further inspection.

  • Method Details

    • isValid

      boolean isValid()

    • response

      HttpResponse response()
      Returns the response object as received from the server for further inspection.
      Returns:
      (undocumented)

    • chosenSubprotocol

      Optional<String> chosenSubprotocol()
      If valid, returns Some(subprotocol) (if any was requested), or None if none was chosen or offered.
      Returns:
      (undocumented)

    • invalidationReason

      String invalidationReason()
      If invalid, the reason why the server's upgrade response could not be accepted.
      Returns:
      (undocumented)