Packages

t

org.apache.pekko.http.scaladsl

OutgoingConnectionBuilder

trait OutgoingConnectionBuilder extends AnyRef

Builder for setting up a flow that will create one single connection per materialization to the specified host. When customization is done, the flow is created using #http(), #https(), #http2() or #http2WithPriorKnowledge().

Not for user extension

Annotations
@DoNotInherit()
Source
OutgoingConnectionBuilder.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OutgoingConnectionBuilder
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def http(): Flow[HttpRequest, HttpResponse, Future[OutgoingConnection]]

    Create a flow that when materialized creates a single HTTP/1.1 plaintext connection with a default port 80 to the server.

  2. abstract def http2(): Flow[HttpRequest, HttpResponse, Future[OutgoingConnection]]

    Create a flow that when materialized creates a single HTTP/2 TLS connection with a default port 443

    Create a flow that when materialized creates a single HTTP/2 TLS connection with a default port 443

    Note that the responses are not guaranteed to arrive in the same order as the requests go out (In the case of a HTTP/2 connection) so therefore requests needs to have a pekko.http.scaladsl.model.RequestResponseAssociation which Pekko HTTP will carry over to the corresponding response for a request.

  3. abstract def http2WithPriorKnowledge(): Flow[HttpRequest, HttpResponse, Future[OutgoingConnection]]

    Create a flow that when materialized creates a single HTTP/2 with 'prior knowledge' plaintext connection with a default port 80

    Create a flow that when materialized creates a single HTTP/2 with 'prior knowledge' plaintext connection with a default port 80

    Note that the responses are not guaranteed to arrive in the same order as the requests go out (In the case of a HTTP/2 connection) so therefore requests needs to have a pekko.http.scaladsl.model.RequestResponseAssociation which Pekko HTTP will carry over to the corresponding response for a request.

  4. abstract def https(): Flow[HttpRequest, HttpResponse, Future[OutgoingConnection]]

    Create a flow that when materialized creates a single HTTP/1.1 TLS connection with a default port 443

  5. abstract def logTo(logger: LoggingAdapter): OutgoingConnectionBuilder

    Use a custom logger

  6. abstract def managedPersistentHttp2(): Flow[HttpRequest, HttpResponse, NotUsed]

    Create a flow that when materialized creates a managed HTTP/2 TLS connection with a default port 443.

    Create a flow that when materialized creates a managed HTTP/2 TLS connection with a default port 443.

    The connection will be re-established as needed.

    Note that the responses are not guaranteed to arrive in the same order as the requests go out so therefore requests needs to have a pekko.http.scaladsl.model.RequestResponseAssociation which Pekko HTTP will carry over to the corresponding response for a request.

    Annotations
    @ApiMayChange()
  7. abstract def managedPersistentHttp2WithPriorKnowledge(): Flow[HttpRequest, HttpResponse, NotUsed]

    Create a flow that when materialized creates a single HTTP/2 with 'prior knowledge' plaintext connection with a default port 80

    Create a flow that when materialized creates a single HTTP/2 with 'prior knowledge' plaintext connection with a default port 80

    The connection will be re-established as needed.

    Note that the responses are not guaranteed to arrive in the same order as the requests go out (In the case of a HTTP/2 connection) so therefore requests needs to have a pekko.http.scaladsl.model.RequestResponseAssociation which Pekko HTTP will carry over to the corresponding response for a request.

    Annotations
    @ApiMayChange()
  8. abstract def toHost(host: String): OutgoingConnectionBuilder

    Change which host flows built with this builder connects to

  9. abstract def toPort(port: Int): OutgoingConnectionBuilder

    Change with port flows built with this builder connects to, if not set the protocol default is used.

  10. abstract def withClientConnectionSettings(settings: ClientConnectionSettings): OutgoingConnectionBuilder

    Use custom ClientConnectionSettings for the connection.

  11. abstract def withCustomHttpsConnectionContext(httpsConnectionContext: HttpsConnectionContext): OutgoingConnectionBuilder

    Use a custom HttpsConnectionContext for the connection.

    Use a custom HttpsConnectionContext for the connection. Only applicable for https() and http2(), overrides defaultHttpsContext

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from OutgoingConnectionBuilder toany2stringadd[OutgoingConnectionBuilder] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (OutgoingConnectionBuilder, B)
    Implicit
    This member is added by an implicit conversion from OutgoingConnectionBuilder toArrowAssoc[OutgoingConnectionBuilder] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (OutgoingConnectionBuilder) => Boolean, msg: => Any): OutgoingConnectionBuilder
    Implicit
    This member is added by an implicit conversion from OutgoingConnectionBuilder toEnsuring[OutgoingConnectionBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (OutgoingConnectionBuilder) => Boolean): OutgoingConnectionBuilder
    Implicit
    This member is added by an implicit conversion from OutgoingConnectionBuilder toEnsuring[OutgoingConnectionBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): OutgoingConnectionBuilder
    Implicit
    This member is added by an implicit conversion from OutgoingConnectionBuilder toEnsuring[OutgoingConnectionBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): OutgoingConnectionBuilder
    Implicit
    This member is added by an implicit conversion from OutgoingConnectionBuilder toEnsuring[OutgoingConnectionBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from OutgoingConnectionBuilder toStringFormat[OutgoingConnectionBuilder] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (OutgoingConnectionBuilder, B)
    Implicit
    This member is added by an implicit conversion from OutgoingConnectionBuilder toArrowAssoc[OutgoingConnectionBuilder] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromOutgoingConnectionBuilder to any2stringadd[OutgoingConnectionBuilder]

Inherited by implicit conversion StringFormat fromOutgoingConnectionBuilder to StringFormat[OutgoingConnectionBuilder]

Inherited by implicit conversion Ensuring fromOutgoingConnectionBuilder to Ensuring[OutgoingConnectionBuilder]

Inherited by implicit conversion ArrowAssoc fromOutgoingConnectionBuilder to ArrowAssoc[OutgoingConnectionBuilder]

Ungrouped