Class WebSocketClientBlueprint

java.lang.Object
org.apache.pekko.http.impl.engine.ws.WebSocketClientBlueprint

public class WebSocketClientBlueprint extends Object
INTERNAL API
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static org.apache.pekko.stream.scaladsl.BidiFlow<Message,org.apache.pekko.stream.TLSProtocol.SslTlsOutbound,org.apache.pekko.stream.TLSProtocol.SslTlsInbound,Message,scala.concurrent.Future<WebSocketUpgradeResponse>>
    apply(WebSocketRequest request, ClientConnectionSettings settings, org.apache.pekko.event.LoggingAdapter log)
    Returns a WebSocketClientLayer that can be materialized once.
    static org.apache.pekko.stream.scaladsl.BidiFlow<org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,scala.concurrent.Future<WebSocketUpgradeResponse>>
    handshake(WebSocketRequest request, ClientConnectionSettings settings, org.apache.pekko.event.LoggingAdapter log)
    A bidi flow that injects and inspects the WS handshake and then goes out of the way.
    static org.apache.pekko.stream.scaladsl.BidiFlow<org.apache.pekko.stream.TLSProtocol.SslTlsInbound,org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.stream.TLSProtocol.SendBytes,org.apache.pekko.NotUsed>
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • WebSocketClientBlueprint

      public WebSocketClientBlueprint()
  • Method Details

    • apply

      public static org.apache.pekko.stream.scaladsl.BidiFlow<Message,org.apache.pekko.stream.TLSProtocol.SslTlsOutbound,org.apache.pekko.stream.TLSProtocol.SslTlsInbound,Message,scala.concurrent.Future<WebSocketUpgradeResponse>> apply(WebSocketRequest request, ClientConnectionSettings settings, org.apache.pekko.event.LoggingAdapter log)
      Returns a WebSocketClientLayer that can be materialized once.
      Parameters:
      request - (undocumented)
      settings - (undocumented)
      log - (undocumented)
      Returns:
      (undocumented)
    • handshake

      public static org.apache.pekko.stream.scaladsl.BidiFlow<org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,scala.concurrent.Future<WebSocketUpgradeResponse>> handshake(WebSocketRequest request, ClientConnectionSettings settings, org.apache.pekko.event.LoggingAdapter log)
      A bidi flow that injects and inspects the WS handshake and then goes out of the way. This BidiFlow can only be materialized once.
      Parameters:
      request - (undocumented)
      settings - (undocumented)
      log - (undocumented)
      Returns:
      (undocumented)
    • simpleTls

      public static org.apache.pekko.stream.scaladsl.BidiFlow<org.apache.pekko.stream.TLSProtocol.SslTlsInbound,org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.stream.TLSProtocol.SendBytes,org.apache.pekko.NotUsed> simpleTls()