RequiresLagomServicePort

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

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from RequiresLagomServicePort to any2stringadd[RequiresLagomServicePort] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (RequiresLagomServicePort, B)

Implicit information
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()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def ensuring(cond: (RequiresLagomServicePort) ⇒ Boolean, msg: ⇒ Any): RequiresLagomServicePort

Implicit information
This member is added by an implicit conversion from RequiresLagomServicePort to Ensuring[RequiresLagomServicePort] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (RequiresLagomServicePort) ⇒ Boolean): RequiresLagomServicePort

Implicit information
This member is added by an implicit conversion from RequiresLagomServicePort to Ensuring[RequiresLagomServicePort] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): RequiresLagomServicePort

Implicit information
This member is added by an implicit conversion from RequiresLagomServicePort to Ensuring[RequiresLagomServicePort] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): RequiresLagomServicePort

Implicit information
This member is added by an implicit conversion from RequiresLagomServicePort to Ensuring[RequiresLagomServicePort] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
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()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def provideLagomServicePort(port: Int): Unit

Provide the Lagom service port.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (RequiresLagomServicePort, B)

Implicit information
This member is added by an implicit conversion from RequiresLagomServicePort to ArrowAssoc[RequiresLagomServicePort] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Related Doc: package server

trait RequiresLagomServicePort extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (RequiresLagomServicePort, B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (RequiresLagomServicePort) ⇒ Boolean, msg: ⇒ Any): RequiresLagomServicePort

def ensuring(cond: (RequiresLagomServicePort) ⇒ Boolean): RequiresLagomServicePort

def ensuring(cond: Boolean, msg: ⇒ Any): RequiresLagomServicePort

def ensuring(cond: Boolean): RequiresLagomServicePort

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final val lagomServicePort: Future[Int]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def provideLagomServicePort(port: Int): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (RequiresLagomServicePort, B)

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