Packages

c

com.twitter.inject.server

AbstractTwitterServer

abstract class AbstractTwitterServer extends AbstractApp with TwitterServer

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractTwitterServer
  2. TwitterServer
  3. Warmup
  4. Ports
  5. TwitterServer
  6. Lifecycle
  7. AdminHttpServer
  8. Hooks
  9. DtabFlags
  10. Linters
  11. Stats
  12. AbstractApp
  13. App
  14. Logging
  15. Slf4jBridge
  16. App
  17. Lifecycle
  18. CloseOnceAwaitably
  19. CloseOnceAwaitably0
  20. Awaitable
  21. ClosableOnce
  22. CloseOnce
  23. Closable
  24. AnyRef
  25. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AbstractTwitterServer()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final val MinGrace: Duration
    Definition Classes
    App
  5. def addAdminRoute(route: Route): Unit
    Definition Classes
    AdminHttpServer
  6. def addAdminRoutes(newRoutes: Seq[Route]): Unit
    Definition Classes
    AdminHttpServer
  7. def addDtabs(): Unit
    Definition Classes
    DtabFlags
  8. def addFrameworkModule(module: Module): Unit
    Attributes
    protected[twitter]
    Definition Classes
    App
  9. def addFrameworkModules(modules: Module*): Unit
    Attributes
    protected[twitter]
    Definition Classes
    App
  10. def addFrameworkOverrideModules(modules: Module*): Unit
    Attributes
    protected[inject]
    Definition Classes
    App
  11. def adminBoundAddress: InetSocketAddress
    Definition Classes
    AdminHttpServer
  12. val adminHttpServer: ListeningServer
    Attributes
    protected
    Definition Classes
    AdminHttpServer
    Annotations
    @volatile()
  13. val adminPort: Flag[InetSocketAddress]
    Definition Classes
    AdminHttpServer
  14. def afterPostWarmup(): Unit

    After postWarmup, all external servers have been started, and we can now enable our health endpoint.

    After postWarmup, all external servers have been started, and we can now enable our health endpoint.

    Attributes
    protected
    Definition Classes
    TwitterServer → App
    Annotations
    @Lifecycle()
    Note

    You MUST call super.afterPostWarmup() in any overridden definition of this method. Failure to do so may cause your server to not completely startup.

    ,

    It is NOT expected that you block in this method as you will prevent completion of the server lifecycle.

    See also

    com.twitter.server.Lifecycle.Warmup#warmupComplete

    com.twitter.inject.app.App#afterPostwarmup

  15. def allowUndefinedFlags: Boolean
    Attributes
    protected
    Definition Classes
    App
  16. def args: Array[String]
    Definition Classes
    App
  17. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  18. def await(awaitables: Awaitable[_]*): Unit

    Callback to register multiple Awaitable instances for the server to await (block) on.

    Callback to register multiple Awaitable instances for the server to await (block) on.

    awaitables

    vararg list of Awaitable instances to register.

    Attributes
    protected
    Definition Classes
    TwitterServer
    See also

    Awaitable)

  19. def await[T <: Awaitable[_]](awaitable: T): Unit

    Callback to register an Awaitable instance for the server to await (block) on.

    Callback to register an Awaitable instance for the server to await (block) on.

    All registered Awaitable instances are entangled by the server such that if any registered Awaitable exits it will trigger all registered Awaitable instances to exit.

    awaitable

    an Awaitable instance to register.

    Attributes
    protected
    Definition Classes
    TwitterServer
    See also

    Awaiting Awaitables

  20. def beforePostWarmup(): Unit

    After warmup but before accepting traffic promote to old gen (which triggers gc).

    After warmup but before accepting traffic promote to old gen (which triggers gc).

    Attributes
    protected
    Definition Classes
    TwitterServer → App
    Annotations
    @Lifecycle()
    Note

    You MUST call super.beforePostWarmup() in any overridden definition of this method. Failure to do so may cause your server to not completely startup.

    ,

    It is NOT expected that you block in this method as you will prevent completion of the server lifecycle.

    See also

    com.twitter.server.Lifecycle.Warmup#prebindWarmup

    com.twitter.inject.app.App#beforePostWarmup

  21. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. final def close(deadline: Time): Future[Unit]
    Definition Classes
    CloseOnce → Closable
  23. def close(after: Duration): Future[Unit]
    Definition Classes
    Closable
  24. final def close(): Future[Unit]
    Definition Classes
    Closable
  25. final def closeFuture: Future[Unit]
    Attributes
    protected
    Definition Classes
    CloseOnce
  26. final def closeOnExit(closable: Closable): Unit
    Definition Classes
    App
  27. final def closeOnExitLast(closable: Closable): Unit
    Definition Classes
    App
  28. def closeOnce(deadline: Time): Future[Unit]
    Attributes
    protected
    Definition Classes
    App → CloseOnce
  29. def configureAdminHttpServer(server: Server): Server
    Attributes
    protected
    Definition Classes
    AdminHttpServer
  30. final def createFlag[T](name: String, default: T, help: String, flaggable: Flaggable[T]): Flag[T]
    Definition Classes
    AbstractApp
  31. final def createMandatoryFlag[T](name: String, help: String, usage: String, flaggable: Flaggable[T]): Flag[T]
    Definition Classes
    AbstractApp
  32. def debug(marker: Marker, message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  33. def debug(message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  34. def debug(marker: Marker, message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  35. def debug(message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  36. def debugResult[T](message: ⇒ String)(fn: ⇒ T): T
    Attributes
    protected[this]
    Definition Classes
    Logging
  37. def defaultAdminPort: Int
    Definition Classes
    AdminHttpServer
  38. def defaultCloseGracePeriod: Duration
    Definition Classes
    App
  39. def disableAdminHttpServer: Boolean
    Attributes
    protected
    Definition Classes
    AdminHttpServer
  40. val dtabAddBaseFlag: Flag[Dtab]
    Definition Classes
    DtabFlags
  41. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  43. def error(marker: Marker, message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  44. def error(message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  45. def error(marker: Marker, message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  46. def error(message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  47. def errorResult[T](message: ⇒ String)(fn: ⇒ T): T
    Attributes
    protected[this]
    Definition Classes
    Logging
  48. def exitOnError(reason: String, details: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    App
  49. def exitOnError(reason: String): Unit
    Attributes
    protected
    Definition Classes
    App
  50. def exitOnError(throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    App
  51. def failfastOnFlagsNotParsed: Boolean
    Attributes
    protected
    Definition Classes
    App → App
  52. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  53. final def flag: app.Flags
    Definition Classes
    App
  54. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  55. val group: String
    Definition Classes
    Lifecycle
  56. def handle(clazz: Class[_ <: Handler]): Unit

    Utility to run a com.twitter.inject.utils.Handler.

    Utility to run a com.twitter.inject.utils.Handler. This is generally used for running a warmup handler in TwitterServer.warmup.

    Attributes
    protected
    Definition Classes
    TwitterServer
    See also

    com.twitter.inject.utils.Handler

  57. def handle[T <: Handler]()(implicit arg0: Manifest[T]): Unit

    Utility to run a com.twitter.inject.utils.Handler.

    Utility to run a com.twitter.inject.utils.Handler. This is generally used for running a warmup handler in TwitterServer.warmup.

    T

    - type parameter with upper-bound of com.twitter.inject.utils.Handler

    Attributes
    protected
    Definition Classes
    TwitterServer
    See also

    com.twitter.inject.utils.Handler

  58. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  59. def httpExternalPort: Option[Int]
    Definition Classes
    Ports
  60. def httpsExternalPort: Option[Int]
    Definition Classes
    Ports
  61. def includeGlobalFlags: Boolean
    Attributes
    protected
    Definition Classes
    App
  62. def info(marker: Marker, message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  63. def info(message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  64. def info(marker: Marker, message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  65. def info(message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  66. def infoResult[T](message: ⇒ String)(fn: ⇒ T): T
    Attributes
    protected[this]
    Definition Classes
    Logging
  67. final def init(f: ⇒ Unit): Unit
    Attributes
    protected
    Definition Classes
    App
  68. def injector: Injector
    Definition Classes
    App
  69. final def isClosed: Boolean
    Definition Classes
    CloseOnce
  70. def isDebugEnabled(marker: Marker): Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  71. def isDebugEnabled: Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  72. def isErrorEnabled(marker: Marker): Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  73. def isErrorEnabled: Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  74. def isInfoEnabled(marker: Marker): Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  75. def isInfoEnabled: Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  76. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  77. def isReady(implicit permit: CanAwait): Boolean
    Definition Classes
    CloseOnceAwaitably0 → Awaitable
  78. def isTraceEnabled(marker: Marker): Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  79. def isTraceEnabled: Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  80. def isWarnEnabled(marker: Marker): Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  81. def isWarnEnabled: Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  82. def javaModules: Collection[Module]
    Attributes
    protected
    Definition Classes
    App
  83. def javaOverrideModules: Collection[Module]
    Attributes
    protected
    Definition Classes
    App
  84. def libraryName: String

    Name used for registration in the com.twitter.util.registry.Library

    Name used for registration in the com.twitter.util.registry.Library

    returns

    library name to register in the Library registry.

    Attributes
    protected
    Definition Classes
    TwitterServer → AdminHttpServer
  85. def linterRules: Seq[Rule]
    Definition Classes
    Linters
  86. def loadModules(): InstalledModules
    Attributes
    protected[inject]
    Definition Classes
    App
  87. def loadServiceBindings: Seq[Binding[_]]
    Attributes
    protected[this]
    Definition Classes
    App
  88. final def logger: Logger
    Attributes
    protected[this]
    Definition Classes
    Logging
  89. final def loggerName: String
    Attributes
    protected[this]
    Definition Classes
    Logging
  90. final def main(): Unit
    Definition Classes
    TwitterServer → App
  91. final def main(args: Array[String]): Unit
    Definition Classes
    App
  92. def modules: Seq[Module]
    Attributes
    protected
    Definition Classes
    App
  93. def name: String
    Definition Classes
    App
  94. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  95. final def nonExitingMain(args: Array[String]): Unit
    Definition Classes
    App
  96. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  97. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  98. final def observe(event: Event)(f: ⇒ Unit): Unit
    Attributes
    protected
    Definition Classes
    Lifecycle
  99. final def observeFuture(event: Event)(f: Future[Unit]): Future[Unit]
    Attributes
    protected
    Definition Classes
    Lifecycle
  100. def onExit(): Unit
    Definition Classes
    AbstractApp
  101. final def onExit(f: ⇒ Unit): Unit
    Attributes
    protected
    Definition Classes
    App
  102. def onExitLast(): Unit
    Definition Classes
    AbstractApp
  103. final def onExitLast(f: ⇒ Unit): Unit
    Attributes
    protected
    Definition Classes
    App
  104. def onInit(): Unit
    Definition Classes
    AbstractApp
  105. def overrideModules: Seq[Module]
    Attributes
    protected
    Definition Classes
    App
  106. def parseArgs(args: Array[String]): Unit
    Attributes
    protected[this]
    Definition Classes
    App
  107. def postInjectorStartup(): Unit

    After creation of the Injector.

    After creation of the Injector. Before any other lifecycle methods.

    Attributes
    protected
    Definition Classes
    TwitterServer → App
    Annotations
    @Lifecycle()
    Note

    You MUST call super.postInjectorStartup() in any overridden definition of this method. Failure to do so may cause your server to not completely startup.

    ,

    It is NOT expected that you block in this method as you will prevent completion of the server lifecycle.

  108. def postMain(): Unit
    Definition Classes
    AbstractApp
  109. def postWarmup(): Unit

    If you override this method to create and bind any external interface or to instantiate any awaitable it is expected that you add the Awaitable (or com.twitter.finagle.ListeningServer) to the list of Awaitables using the await[T <: Awaitable[_(awaitable: T): Unit function.

    If you override this method to create and bind any external interface or to instantiate any awaitable it is expected that you add the Awaitable (or com.twitter.finagle.ListeningServer) to the list of Awaitables using the await[T <: Awaitable[_(awaitable: T): Unit function.

    Attributes
    protected
    Definition Classes
    TwitterServer → App
    Annotations
    @Lifecycle()
    Note

    You MUST call super.postWarmup() in any overridden definition of this method. Failure to do so may cause your server to not completely startup.

    ,

    It is NOT expected that you block in this method as you will prevent completion of the server lifecycle.

  110. final def postmain(f: ⇒ Unit): Unit
    Attributes
    protected
    Definition Classes
    App
  111. def preMain(): Unit
    Definition Classes
    AbstractApp
  112. def prebindWarmup(): Unit
    Definition Classes
    Warmup
  113. final def premain(f: ⇒ Unit): Unit
    Attributes
    protected
    Definition Classes
    App
  114. def ready(timeout: Duration)(implicit permit: CanAwait): AbstractTwitterServer.this.type
    Definition Classes
    CloseOnceAwaitably0 → Awaitable
  115. def resolveFinagleClientsOnStartup: Boolean

    Resolve all Finagle clients before warmup method called

    Resolve all Finagle clients before warmup method called

    Attributes
    protected
    Definition Classes
    TwitterServer
  116. def result(timeout: Duration)(implicit permit: CanAwait): Unit
    Definition Classes
    CloseOnceAwaitably0 → Awaitable
  117. def routes: Seq[Route]
    Definition Classes
    AdminHttpServer
  118. final def run(): Unit

    Attributes
    protected
    Definition Classes
    TwitterServer → App
    See also

    com.twitter.inject.server.TwitterServer#start

  119. final def runOnExit(runnable: Runnable): Unit
    Attributes
    protected
    Definition Classes
    App
  120. final def runOnExitLast(runnable: Runnable): Unit
    Attributes
    protected
    Definition Classes
    App
  121. def setup(): Unit

    Callback method which is executed specifically in the postInjectorStartup lifecycle phase of this server.

    Callback method which is executed specifically in the postInjectorStartup lifecycle phase of this server.

    This is AFTER the injector is created but BEFORE server warmup has been performed.

    This method is thus suitable for starting and awaiting on PubSub publishers or subscribers.

    The server is NOT signaled to be started until AFTER this method has executed thus it is imperative that this method is NOT BLOCKED as it will cause the server to not complete startup.

    This method can be used to start long-lived processes that run in separate threads from the main() thread. It is expected that you manage these threads manually, e.g., by using a com.twitter.util.FuturePool.

    If you override this method to instantiate any com.twitter.util.Awaitable it is expected that you add the com.twitter.util.Awaitable to the list of Awaitables using the await[T <: Awaitable[_]](awaitable: T): Unit function if you want the server to exit when the com.twitter.util.Awaitable exits.

    Any exceptions thrown in this method will result in the server exiting.

    Attributes
    protected
    Definition Classes
    TwitterServer
  122. lazy val shutdownTimer: Timer
    Attributes
    protected
    Definition Classes
    TwitterServer → App
  123. def start(): Unit

    Callback method which is executed after the injector is created and all lifecycle methods have fully completed but before awaiting on any Awaitables.

    Callback method which is executed after the injector is created and all lifecycle methods have fully completed but before awaiting on any Awaitables. It is NOT expected that you block in this method as you will prevent completion of the server lifecycle.

    The server is signaled as STARTED prior to the execution of this callback as all lifecycle methods have successfully completed and the admin and any external interfaces have started.

    This method can be used to start long-lived processes that run in separate threads from the main() thread. It is expected that you manage these threads manually, e.g., by using a com.twitter.util.FuturePool.

    Any exceptions thrown in this method will result in the server exiting.

    Attributes
    protected
    Definition Classes
    TwitterServer
  124. def startAdminHttpServer(): Unit
    Attributes
    protected
    Definition Classes
    AdminHttpServer
  125. final def startupCompletionEvent: Event
    Attributes
    protected[twitter]
    Definition Classes
    TwitterServer → Warmup → TwitterServer
  126. def statsReceiver: StatsReceiver
    Definition Classes
    Stats
  127. def statsReceiverModule: Module

    Default com.twitter.inject.TwitterModule for providing a com.twitter.finagle.stats.StatsReceiver.

    Default com.twitter.inject.TwitterModule for providing a com.twitter.finagle.stats.StatsReceiver.

    returns

    a com.twitter.inject.TwitterModule which provides a com.twitter.finagle.stats.StatsReceiver implementation.

    Attributes
    protected
    Definition Classes
    TwitterServer
  128. final val suppressGracefulShutdownErrors: Boolean
    Definition Classes
    TwitterServer → App
  129. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  130. def thriftPort: Option[Int]
    Definition Classes
    Ports
  131. def toString(): String
    Definition Classes
    AnyRef → Any
  132. def trace(marker: Marker, message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  133. def trace(message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  134. def trace(marker: Marker, message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  135. def trace(message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  136. def traceResult[T](message: ⇒ String)(fn: ⇒ T): T
    Attributes
    protected[this]
    Definition Classes
    Logging
  137. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  138. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  139. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  140. def warmup(): Unit

    Callback method run before TwitterServer.postWarmup, used for performing warm up of this server.

    Callback method run before TwitterServer.postWarmup, used for performing warm up of this server. Override, but do not call super.warmup() as you will trigger a lint rule violation.

    Any exceptions thrown in this method will result in the app exiting.

    Attributes
    protected
    Definition Classes
    TwitterServer → App
    See also

    HTTP Server Warmup

    Thrift Server Warmup

  141. def warmupComplete(): Unit
    Definition Classes
    Warmup
  142. def warn(marker: Marker, message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  143. def warn(message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  144. def warn(marker: Marker, message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  145. def warn(message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  146. def warnResult[T](message: ⇒ String)(fn: ⇒ T): T
    Attributes
    protected[this]
    Definition Classes
    Logging

Inherited from TwitterServer

Inherited from Warmup

Inherited from Ports

Inherited from server.TwitterServer

Inherited from Lifecycle

Inherited from AdminHttpServer

Inherited from Hooks

Inherited from DtabFlags

Inherited from Linters

Inherited from Stats

Inherited from AbstractApp

Inherited from App

Inherited from Logging

Inherited from Slf4jBridge

Inherited from App

Inherited from Lifecycle

Inherited from CloseOnceAwaitably

Inherited from CloseOnceAwaitably0[Unit]

Inherited from Awaitable[Unit]

Inherited from ClosableOnce

Inherited from CloseOnce

Inherited from Closable

Inherited from AnyRef

Inherited from Any

Ungrouped