t

com.lightbend.lagom.scaladsl.server

RequiresLagomServicePort

trait RequiresLagomServicePort extends AnyRef

When using dynamic port allocation, a circular dependency may exist if the application needs to know what port it's running on, since the port won't be know until after the server has bound to the listening port (the OS will select a free port at bind time), but we can't bind the server to the listening port until we have an application to service incoming requests.

This trait allows that circular dependency to be resolved, by making the port available as a future, and allowing it to be provided after the application has been created using the RequiresLagomServicePort.provideLagomServicePort() method.

This is primarily useful for testing, where dynamic port allocation is often used.

Source
LagomApplicationLoader.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
LocalServiceLocator
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RequiresLagomServicePort
  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. All

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 RequiresLagomServicePort to any2stringadd[RequiresLagomServicePort] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (RequiresLagomServicePort, B)
    Implicit
    This member is added by an implicit conversion from RequiresLagomServicePort to ArrowAssoc[RequiresLagomServicePort] 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( ... ) @native()
  8. def ensuring(cond: (RequiresLagomServicePort) ⇒ Boolean, msg: ⇒ Any): RequiresLagomServicePort
    Implicit
    This member is added by an implicit conversion from RequiresLagomServicePort to Ensuring[RequiresLagomServicePort] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (RequiresLagomServicePort) ⇒ Boolean): RequiresLagomServicePort
    Implicit
    This member is added by an implicit conversion from RequiresLagomServicePort to Ensuring[RequiresLagomServicePort] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): RequiresLagomServicePort
    Implicit
    This member is added by an implicit conversion from RequiresLagomServicePort to Ensuring[RequiresLagomServicePort] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): RequiresLagomServicePort
    Implicit
    This member is added by an implicit conversion from RequiresLagomServicePort to Ensuring[RequiresLagomServicePort] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from RequiresLagomServicePort to StringFormat[RequiresLagomServicePort] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final val lagomServicePort: Future[Int]

    The service port.

    The service port. This will be redeemed when provideLagomServicePort() is invoked.

    Anything that needs to know what port the app is running on can attach callbacks to this to handle it.

  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def provideLagomServicePort(port: Int): Unit

    Provide the Lagom service port.

  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  29. def →[B](y: B): (RequiresLagomServicePort, B)
    Implicit
    This member is added by an implicit conversion from RequiresLagomServicePort to ArrowAssoc[RequiresLagomServicePort] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from RequiresLagomServicePort to any2stringadd[RequiresLagomServicePort]

Inherited by implicit conversion StringFormat from RequiresLagomServicePort to StringFormat[RequiresLagomServicePort]

Inherited by implicit conversion Ensuring from RequiresLagomServicePort to Ensuring[RequiresLagomServicePort]

Inherited by implicit conversion ArrowAssoc from RequiresLagomServicePort to ArrowAssoc[RequiresLagomServicePort]

Ungrouped