TwitterServer

trait TwitterServer extends App with server.TwitterServer with Ports with Warmup

A com.twitter.server.TwitterServer that supports injection and com.twitter.inject.TwitterModule modules.

To use, override the appropriate @Lifecycle and callback method(s). Make sure when overriding

@Lifecycle

methods to call the super implementation, otherwise critical lifecycle set-up may not occur causing your server to either function improperly or outright fail.

If you are extending this trait, to implement your server, override the start() function, e.g.,

import com.twitter.inject.server.TwitterServer

object MyServerMain extends MyServer

class MyServer extends TwitterServer {
  override protected def start(): Unit = {
     // YOUR CODE HERE

     await(someAwaitable)
  }
}

Note, you do not need to await on the adminHttpServer as this is done for you by the framework.

Server Lifecycle: +-------------------------------------------------------------------------+

Life Cycle Method	Ancillary Function(s)

+-------------------------------------------------------------------------+

loadModules()

+-------------------------------------------------------------------------+

modules.postInjectorStartup()	foreach.singletonStartup()

+-------------------------------------------------------------------------+

postInjectorStartup()	resolveFinagleClientsOnStartup(),
	setup()

+-------------------------------------------------------------------------+

warmup()

+-------------------------------------------------------------------------+

beforePostWarmup()	LifeCycle.Warmup.prebindWarmup()

+-------------------------------------------------------------------------+

postWarmup() (binds ext ports)	disable or announce admin server

+-------------------------------------------------------------------------+

afterpostwarmup()	LifeCycle.Warmup.warmupComplete()

+-------------------------------------------------------------------------+

setAppStarted()

+-------------------------------------------------------------------------+

run()	start()

+-------------------------------------------------------------------------+

Await on awaitables

+-------------------------------------------------------------------------+ @Lifecycle }}} occur causing your server to either function improperly or outright fail.

If you are extending this trait, to implement your server, override the start() function, e.g.,

import com.twitter.inject.server.TwitterServer

object MyServerMain extends MyServer

class MyServer extends TwitterServer {
  override protected def start(): Unit = {
     // YOUR CODE HERE

     await(someAwaitable)
  }
}

Note, you do not need to await on the adminHttpServer as this is done for you by the framework.

Server Lifecycle: +-------------------------------------------------------------------------+

Life Cycle Method	Ancillary Function(s)

+-------------------------------------------------------------------------+

loadModules()

+-------------------------------------------------------------------------+

modules.postInjectorStartup()	foreach.singletonStartup()

+-------------------------------------------------------------------------+

postInjectorStartup()	resolveFinagleClientsOnStartup(),
	setup()

+-------------------------------------------------------------------------+

warmup()

+-------------------------------------------------------------------------+

beforePostWarmup()	LifeCycle.Warmup.prebindWarmup()

+-------------------------------------------------------------------------+

postWarmup() (binds ext ports)	disable or announce admin server

+-------------------------------------------------------------------------+

afterpostwarmup()	LifeCycle.Warmup.warmupComplete()

+-------------------------------------------------------------------------+

setAppStarted()

+-------------------------------------------------------------------------+

run()	start()

+-------------------------------------------------------------------------+

Await on awaitables

+-------------------------------------------------------------------------+

See also: Creating an Injectable TwitterServer

Linear Supertypes

Warmup, Ports, server.TwitterServer, Lifecycle, AdminHttpServer, Hooks, DtabFlags, Linters, Stats, App, util.logging.Logging, Slf4jBridge, App, Lifecycle, CloseOnceAwaitably, CloseOnceAwaitably0[Unit], Awaitable[Unit], ClosableOnce, CloseOnce, Closable, AnyRef, Any

Known Subclasses

AbstractHttpServer, AbstractHttpServerTrait, HttpServer, HttpServerTrait, AbstractThriftServer, AbstractThriftServerTrait, ThriftServer, ThriftServerTrait, AbstractTwitterServer

Ordering

Alphabetic
By Inheritance

Inherited

TwitterServer
Warmup
Ports
TwitterServer
Lifecycle
AdminHttpServer
Hooks
DtabFlags
Linters
Stats
App
Logging
Slf4jBridge
App
Lifecycle
CloseOnceAwaitably
CloseOnceAwaitably0
Awaitable
ClosableOnce
CloseOnce
Closable
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final val MinGrace: Duration
Definition Classes
App
def addAdminRoute(route: Route): Unit
Definition Classes
AdminHttpServer
def addAdminRoutes(newRoutes: Seq[Route]): Unit
Definition Classes
AdminHttpServer
def addDtabs(): Unit
Definition Classes
DtabFlags
def addFrameworkModule(module: Module): Unit
ONLY INTENDED FOR USE BY THE FRAMEWORK.
ONLY INTENDED FOR USE BY THE FRAMEWORK.
Default modules can be overridden in production by overriding methods in your App or Server.
We take special care to make sure the module is not null, since a common bug is overriding the default methods using a val instead of a def
Attributes
protected[twitter]
Definition Classes
App
def addFrameworkModules(modules: Module*): Unit
ONLY INTENDED FOR USE BY THE FRAMEWORK.
ONLY INTENDED FOR USE BY THE FRAMEWORK.
Attributes
protected[twitter]
Definition Classes
App
def addFrameworkOverrideModules(modules: Module*): Unit
ONLY INTENDED FOR USE BY THE FRAMEWORK.
ONLY INTENDED FOR USE BY THE FRAMEWORK.
Attributes
protected[inject]
Definition Classes
App
def adminBoundAddress: InetSocketAddress
Definition Classes
AdminHttpServer
val adminHttpServer: ListeningServer
Attributes
protected
Definition Classes
AdminHttpServer
Annotations
@volatile()
val adminPort: Flag[InetSocketAddress]
Definition Classes
AdminHttpServer
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
def allowUndefinedFlags: Boolean
Attributes
protected
Definition Classes
App
def args: Array[String]
Definition Classes
App
final def asInstanceOf[T0]: T0
Definition Classes
Any
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
See also
Awaitable)
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
See also
Awaiting Awaitables
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
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def close(deadline: Time): Future[Unit]
Definition Classes
CloseOnce → Closable
def close(after: Duration): Future[Unit]
Definition Classes
Closable
final def close(): Future[Unit]
Definition Classes
Closable
final def closeFuture: Future[Unit]
Attributes
protected
Definition Classes
CloseOnce
final def closeOnExit(closable: Closable): Unit
Definition Classes
App
final def closeOnExitLast(closable: Closable): Unit
Definition Classes
App
def closeOnce(deadline: Time): Future[Unit]
Attributes
protected
Definition Classes
App → CloseOnce
def configureAdminHttpServer(server: Server): Server
Attributes
protected
Definition Classes
AdminHttpServer
def debug(marker: Marker, message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def debug(message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def debug(marker: Marker, message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def debug(message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def debugResult[T](message: => String)(fn: => T): T
Attributes
protected[this]
Definition Classes
Logging
def defaultAdminPort: Int
Definition Classes
AdminHttpServer
def defaultCloseGracePeriod: Duration
Definition Classes
App
def disableAdminHttpServer: Boolean
Attributes
protected
Definition Classes
AdminHttpServer
val dtabAddBaseFlag: Flag[Dtab]
Definition Classes
DtabFlags
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def error(marker: Marker, message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def error(message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def error(marker: Marker, message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def error(message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def errorResult[T](message: => String)(fn: => T): T
Attributes
protected[this]
Definition Classes
Logging
def exitOnError(reason: String, details: => String): Unit
Attributes
protected
Definition Classes
App
def exitOnError(reason: String): Unit
Attributes
protected
Definition Classes
App
def exitOnError(throwable: Throwable): Unit
Attributes
protected
Definition Classes
App
def failfastOnFlagsNotParsed: Boolean
<invalid inheritdoc annotation>
<invalid inheritdoc annotation>
Attributes
protected
Definition Classes
App → App
Note
It is HIGHLY recommended that this value remains 'true'. This value SHOULD NOT be changed to 'false' without a very good reason.This method only remains overridable for legacy reasons.
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def flag: app.Flags
Definition Classes
App
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
val group: String
Definition Classes
Lifecycle
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
See also
com.twitter.inject.utils.Handler
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
See also
com.twitter.inject.utils.Handler
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
def httpExternalPort: Option[Int]
Returns the bound port representing the external HTTP interface of this server.
Returns the bound port representing the external HTTP interface of this server.
returns
a defined Some(Int) representing the port of the external HTTP interface if defined and bound, None otherwise.
Definition Classes
Ports
def httpsExternalPort: Option[Int]
Returns the bound port representing the external HTTPS interface of this server.
Returns the bound port representing the external HTTPS interface of this server.
returns
a defined Some(Int) representing the port of the external HTTPS interface if defined and bound, None otherwise.
Definition Classes
Ports
def includeGlobalFlags: Boolean
Attributes
protected
Definition Classes
App
def info(marker: Marker, message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def info(message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def info(marker: Marker, message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def info(message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def infoResult[T](message: => String)(fn: => T): T
Attributes
protected[this]
Definition Classes
Logging
final def init(f: => Unit): Unit
Attributes
protected
Definition Classes
App
def injector: Injector
Definition Classes
App
final def isClosed: Boolean
Definition Classes
CloseOnce
def isDebugEnabled(marker: Marker): Boolean
Attributes
protected[this]
Definition Classes
Logging
def isDebugEnabled: Boolean
Attributes
protected[this]
Definition Classes
Logging
def isErrorEnabled(marker: Marker): Boolean
Attributes
protected[this]
Definition Classes
Logging
def isErrorEnabled: Boolean
Attributes
protected[this]
Definition Classes
Logging
def isInfoEnabled(marker: Marker): Boolean
Attributes
protected[this]
Definition Classes
Logging
def isInfoEnabled: Boolean
Attributes
protected[this]
Definition Classes
Logging
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def isReady(implicit permit: CanAwait): Boolean
Definition Classes
CloseOnceAwaitably0 → Awaitable
def isTraceEnabled(marker: Marker): Boolean
Attributes
protected[this]
Definition Classes
Logging
def isTraceEnabled: Boolean
Attributes
protected[this]
Definition Classes
Logging
def isWarnEnabled(marker: Marker): Boolean
Attributes
protected[this]
Definition Classes
Logging
def isWarnEnabled: Boolean
Attributes
protected[this]
Definition Classes
Logging
def javaModules: Collection[Module]
Production modules from Java.
Production modules from Java.
Attributes
protected
Definition Classes
App
def javaOverrideModules: Collection[Module]
ONLY INTENDED FOR USE IN TESTING.
ONLY INTENDED FOR USE IN TESTING.
Override modules from Java which redefine production bindings (only use overrideModules during testing) If you think you need this in your main server you are most likely doing something incorrectly.
Attributes
protected
Definition Classes
App
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
def linterRules: Seq[Rule]
Definition Classes
Linters
def loadModules(): InstalledModules
ONLY INTENDED FOR USE BY THE FRAMEWORK.
ONLY INTENDED FOR USE BY THE FRAMEWORK.
Attributes
protected[inject]
Definition Classes
App
def loadServiceBindings: Seq[Binding[_]]
Attributes
protected[this]
Definition Classes
App
final def logger: Logger
Attributes
protected[this]
Definition Classes
Logging
final def loggerName: String
Attributes
protected[this]
Definition Classes
Logging
final def main(): Unit
DO NOT BLOCK
DO NOT BLOCK
Definition Classes
TwitterServer → App
final def main(args: Array[String]): Unit
Definition Classes
App
def modules: Seq[Module]
Production modules.
Production modules.
Attributes
protected
Definition Classes
App
Note
Java users should prefer javaModules.
def name: String
Definition Classes
App
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def nonExitingMain(args: Array[String]): Unit
Definition Classes
App
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def observe(event: Event)(f: => Unit): Unit
Attributes
protected
Definition Classes
Lifecycle
final def observeFuture(event: Event)(f: Future[Unit]): Future[Unit]
Attributes
protected
Definition Classes
Lifecycle
final def onExit(f: => Unit): Unit
Attributes
protected
Definition Classes
App
final def onExitLast(f: => Unit): Unit
Attributes
protected
Definition Classes
App
def overrideModules: Seq[Module]
ONLY INTENDED FOR USE IN TESTING.
ONLY INTENDED FOR USE IN TESTING.
Override modules which redefine production bindings (only use overrideModules during testing) If you think you need this in your main server you are most likely doing something incorrectly.
Attributes
protected
Definition Classes
App
def parseArgs(args: Array[String]): Unit
Attributes
protected[this]
Definition Classes
App
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.
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.
final def postmain(f: => Unit): Unit
Attributes
protected
Definition Classes
App
def prebindWarmup(): Unit
Definition Classes
Warmup
final def premain(f: => Unit): Unit
Attributes
protected
Definition Classes
App
def ready(timeout: Duration)(implicit permit: CanAwait): TwitterServer.this.type
Definition Classes
CloseOnceAwaitably0 → Awaitable
def resolveFinagleClientsOnStartup: Boolean
Resolve all Finagle clients before warmup method called
Resolve all Finagle clients before warmup method called
Attributes
protected
def result(timeout: Duration)(implicit permit: CanAwait): Unit
Definition Classes
CloseOnceAwaitably0 → Awaitable
def routes: Seq[Route]
Definition Classes
AdminHttpServer
final def run(): Unit
Attributes
protected
Definition Classes
TwitterServer → App
See also
com.twitter.inject.server.TwitterServer#start
final def runOnExit(runnable: Runnable): Unit
Attributes
protected
Definition Classes
App
final def runOnExitLast(runnable: Runnable): Unit
Attributes
protected
Definition Classes
App
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
lazy val shutdownTimer: Timer
Attributes
protected
Definition Classes
TwitterServer → App
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
def startAdminHttpServer(): Unit
Attributes
protected
Definition Classes
AdminHttpServer
final def startupCompletionEvent: Event
Attributes
protected[twitter]
Definition Classes
TwitterServer → Warmup → TwitterServer
def statsReceiver: StatsReceiver
Definition Classes
Stats
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
final val suppressGracefulShutdownErrors: Boolean
Definition Classes
TwitterServer → App
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def thriftPort: Option[Int]
Returns the bound port representing the external Thrift interface of this server.
Returns the bound port representing the external Thrift interface of this server.
returns
a defined Some(Int) representing the port of the external Thrift interface if defined and bound, None otherwise.
Definition Classes
Ports
def toString(): String
Definition Classes
AnyRef → Any
def trace(marker: Marker, message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def trace(message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def trace(marker: Marker, message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def trace(message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def traceResult[T](message: => String)(fn: => T): T
Attributes
protected[this]
Definition Classes
Logging
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
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
def warmupComplete(): Unit
Definition Classes
Warmup
def warn(marker: Marker, message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def warn(message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def warn(marker: Marker, message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def warn(message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def warnResult[T](message: => String)(fn: => T): T
Attributes
protected[this]
Definition Classes
Logging

Inherited from Warmup

Value Members

def prebindWarmup(): Unit
Definition Classes
Warmup
def warmupComplete(): Unit
Definition Classes
Warmup

Inherited from Ports

Value Members

def httpExternalPort: Option[Int]
Returns the bound port representing the external HTTP interface of this server.
Returns the bound port representing the external HTTP interface of this server.
returns
a defined Some(Int) representing the port of the external HTTP interface if defined and bound, None otherwise.
Definition Classes
Ports
def httpsExternalPort: Option[Int]
Returns the bound port representing the external HTTPS interface of this server.
Returns the bound port representing the external HTTPS interface of this server.
returns
a defined Some(Int) representing the port of the external HTTPS interface if defined and bound, None otherwise.
Definition Classes
Ports
def thriftPort: Option[Int]
Returns the bound port representing the external Thrift interface of this server.
Returns the bound port representing the external Thrift interface of this server.
returns
a defined Some(Int) representing the port of the external Thrift interface if defined and bound, None otherwise.
Definition Classes
Ports

Inherited from server.TwitterServer

Value Members

lazy val shutdownTimer: Timer
Attributes
protected
Definition Classes
TwitterServer → App
final val suppressGracefulShutdownErrors: Boolean
Definition Classes
TwitterServer → App

Inherited from Lifecycle

Value Members

val group: String
Definition Classes
Lifecycle

Inherited from AdminHttpServer

Value Members

def addAdminRoute(route: Route): Unit
Definition Classes
AdminHttpServer
def addAdminRoutes(newRoutes: Seq[Route]): Unit
Definition Classes
AdminHttpServer
def adminBoundAddress: InetSocketAddress
Definition Classes
AdminHttpServer
val adminHttpServer: ListeningServer
Attributes
protected
Definition Classes
AdminHttpServer
Annotations
@volatile()
val adminPort: Flag[InetSocketAddress]
Definition Classes
AdminHttpServer
def configureAdminHttpServer(server: Server): Server
Attributes
protected
Definition Classes
AdminHttpServer
def defaultAdminPort: Int
Definition Classes
AdminHttpServer
def disableAdminHttpServer: Boolean
Attributes
protected
Definition Classes
AdminHttpServer
def routes: Seq[Route]
Definition Classes
AdminHttpServer
def startAdminHttpServer(): Unit
Attributes
protected
Definition Classes
AdminHttpServer

Inherited from DtabFlags

Value Members

def addDtabs(): Unit
Definition Classes
DtabFlags
val dtabAddBaseFlag: Flag[Dtab]
Definition Classes
DtabFlags

Inherited from Linters

Value Members

def linterRules: Seq[Rule]
Definition Classes
Linters

Inherited from Stats

Value Members

def statsReceiver: StatsReceiver
Definition Classes
Stats

Inherited from App

Value Members

def addFrameworkModule(module: Module): Unit
ONLY INTENDED FOR USE BY THE FRAMEWORK.
ONLY INTENDED FOR USE BY THE FRAMEWORK.
Default modules can be overridden in production by overriding methods in your App or Server.
We take special care to make sure the module is not null, since a common bug is overriding the default methods using a val instead of a def
Attributes
protected[twitter]
Definition Classes
App
def addFrameworkModules(modules: Module*): Unit
ONLY INTENDED FOR USE BY THE FRAMEWORK.
ONLY INTENDED FOR USE BY THE FRAMEWORK.
Attributes
protected[twitter]
Definition Classes
App
def addFrameworkOverrideModules(modules: Module*): Unit
ONLY INTENDED FOR USE BY THE FRAMEWORK.
ONLY INTENDED FOR USE BY THE FRAMEWORK.
Attributes
protected[inject]
Definition Classes
App
def failfastOnFlagsNotParsed: Boolean
<invalid inheritdoc annotation>
<invalid inheritdoc annotation>
Attributes
protected
Definition Classes
App → App
Note
It is HIGHLY recommended that this value remains 'true'. This value SHOULD NOT be changed to 'false' without a very good reason.This method only remains overridable for legacy reasons.
def injector: Injector
Definition Classes
App
def javaModules: Collection[Module]
Production modules from Java.
Production modules from Java.
Attributes
protected
Definition Classes
App
def javaOverrideModules: Collection[Module]
ONLY INTENDED FOR USE IN TESTING.
ONLY INTENDED FOR USE IN TESTING.
Override modules from Java which redefine production bindings (only use overrideModules during testing) If you think you need this in your main server you are most likely doing something incorrectly.
Attributes
protected
Definition Classes
App
def loadModules(): InstalledModules
ONLY INTENDED FOR USE BY THE FRAMEWORK.
ONLY INTENDED FOR USE BY THE FRAMEWORK.
Attributes
protected[inject]
Definition Classes
App
def modules: Seq[Module]
Production modules.
Production modules.
Attributes
protected
Definition Classes
App
Note
Java users should prefer javaModules.
def overrideModules: Seq[Module]
ONLY INTENDED FOR USE IN TESTING.
ONLY INTENDED FOR USE IN TESTING.
Override modules which redefine production bindings (only use overrideModules during testing) If you think you need this in your main server you are most likely doing something incorrectly.
Attributes
protected
Definition Classes
App

Inherited from util.logging.Logging

Value Members

def debug(marker: Marker, message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def debug(message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def debug(marker: Marker, message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def debug(message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def debugResult[T](message: => String)(fn: => T): T
Attributes
protected[this]
Definition Classes
Logging
def error(marker: Marker, message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def error(message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def error(marker: Marker, message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def error(message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def errorResult[T](message: => String)(fn: => T): T
Attributes
protected[this]
Definition Classes
Logging
def info(marker: Marker, message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def info(message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def info(marker: Marker, message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def info(message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def infoResult[T](message: => String)(fn: => T): T
Attributes
protected[this]
Definition Classes
Logging
def isDebugEnabled(marker: Marker): Boolean
Attributes
protected[this]
Definition Classes
Logging
def isDebugEnabled: Boolean
Attributes
protected[this]
Definition Classes
Logging
def isErrorEnabled(marker: Marker): Boolean
Attributes
protected[this]
Definition Classes
Logging
def isErrorEnabled: Boolean
Attributes
protected[this]
Definition Classes
Logging
def isInfoEnabled(marker: Marker): Boolean
Attributes
protected[this]
Definition Classes
Logging
def isInfoEnabled: Boolean
Attributes
protected[this]
Definition Classes
Logging
def isTraceEnabled(marker: Marker): Boolean
Attributes
protected[this]
Definition Classes
Logging
def isTraceEnabled: Boolean
Attributes
protected[this]
Definition Classes
Logging
def isWarnEnabled(marker: Marker): Boolean
Attributes
protected[this]
Definition Classes
Logging
def isWarnEnabled: Boolean
Attributes
protected[this]
Definition Classes
Logging
final def logger: Logger
Attributes
protected[this]
Definition Classes
Logging
final def loggerName: String
Attributes
protected[this]
Definition Classes
Logging
def trace(marker: Marker, message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def trace(message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def trace(marker: Marker, message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def trace(message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def traceResult[T](message: => String)(fn: => T): T
Attributes
protected[this]
Definition Classes
Logging
def warn(marker: Marker, message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def warn(message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def warn(marker: Marker, message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def warn(message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def warnResult[T](message: => String)(fn: => T): T
Attributes
protected[this]
Definition Classes
Logging

Inherited from App

Value Members

final val MinGrace: Duration
Definition Classes
App
def allowUndefinedFlags: Boolean
Attributes
protected
Definition Classes
App
def args: Array[String]
Definition Classes
App
final def closeOnExit(closable: Closable): Unit
Definition Classes
App
final def closeOnExitLast(closable: Closable): Unit
Definition Classes
App
def closeOnce(deadline: Time): Future[Unit]
Attributes
protected
Definition Classes
App → CloseOnce
def defaultCloseGracePeriod: Duration
Definition Classes
App
def exitOnError(reason: String, details: => String): Unit
Attributes
protected
Definition Classes
App
def exitOnError(reason: String): Unit
Attributes
protected
Definition Classes
App
def exitOnError(throwable: Throwable): Unit
Attributes
protected
Definition Classes
App
final def flag: app.Flags
Definition Classes
App
def includeGlobalFlags: Boolean
Attributes
protected
Definition Classes
App
final def init(f: => Unit): Unit
Attributes
protected
Definition Classes
App
def loadServiceBindings: Seq[Binding[_]]
Attributes
protected[this]
Definition Classes
App
final def main(args: Array[String]): Unit
Definition Classes
App
def name: String
Definition Classes
App
final def nonExitingMain(args: Array[String]): Unit
Definition Classes
App
final def onExit(f: => Unit): Unit
Attributes
protected
Definition Classes
App
final def onExitLast(f: => Unit): Unit
Attributes
protected
Definition Classes
App
def parseArgs(args: Array[String]): Unit
Attributes
protected[this]
Definition Classes
App
final def postmain(f: => Unit): Unit
Attributes
protected
Definition Classes
App
final def premain(f: => Unit): Unit
Attributes
protected
Definition Classes
App
final def runOnExit(runnable: Runnable): Unit
Attributes
protected
Definition Classes
App
final def runOnExitLast(runnable: Runnable): Unit
Attributes
protected
Definition Classes
App

Inherited from Lifecycle

Value Members

final def observe(event: Event)(f: => Unit): Unit
Attributes
protected
Definition Classes
Lifecycle
final def observeFuture(event: Event)(f: Future[Unit]): Future[Unit]
Attributes
protected
Definition Classes
Lifecycle

Inherited from CloseOnceAwaitably0[Unit]

Value Members

def isReady(implicit permit: CanAwait): Boolean
Definition Classes
CloseOnceAwaitably0 → Awaitable
def ready(timeout: Duration)(implicit permit: CanAwait): TwitterServer.this.type
Definition Classes
CloseOnceAwaitably0 → Awaitable
def result(timeout: Duration)(implicit permit: CanAwait): Unit
Definition Classes
CloseOnceAwaitably0 → Awaitable

Inherited from CloseOnce

Value Members

final def close(deadline: Time): Future[Unit]
Definition Classes
CloseOnce → Closable
final def closeFuture: Future[Unit]
Attributes
protected
Definition Classes
CloseOnce
final def isClosed: Boolean
Definition Classes
CloseOnce

Inherited from Closable

Value Members

def close(after: Duration): Future[Unit]
Definition Classes
Closable
final def close(): Future[Unit]
Definition Classes
Closable

Inherited from AnyRef

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
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(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Any

Value Members

final def asInstanceOf[T0]: T0
Definition Classes
Any
final def isInstanceOf[T0]: Boolean
Definition Classes
Any

Ungrouped

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final val MinGrace: Duration
Definition Classes
App
def addAdminRoute(route: Route): Unit
Definition Classes
AdminHttpServer
def addAdminRoutes(newRoutes: Seq[Route]): Unit
Definition Classes
AdminHttpServer
def addDtabs(): Unit
Definition Classes
DtabFlags
def addFrameworkModule(module: Module): Unit
ONLY INTENDED FOR USE BY THE FRAMEWORK.
ONLY INTENDED FOR USE BY THE FRAMEWORK.
Default modules can be overridden in production by overriding methods in your App or Server.
We take special care to make sure the module is not null, since a common bug is overriding the default methods using a val instead of a def
Attributes
protected[twitter]
Definition Classes
App
def addFrameworkModules(modules: Module*): Unit
ONLY INTENDED FOR USE BY THE FRAMEWORK.
ONLY INTENDED FOR USE BY THE FRAMEWORK.
Attributes
protected[twitter]
Definition Classes
App
def addFrameworkOverrideModules(modules: Module*): Unit
ONLY INTENDED FOR USE BY THE FRAMEWORK.
ONLY INTENDED FOR USE BY THE FRAMEWORK.
Attributes
protected[inject]
Definition Classes
App
def adminBoundAddress: InetSocketAddress
Definition Classes
AdminHttpServer
val adminHttpServer: ListeningServer
Attributes
protected
Definition Classes
AdminHttpServer
Annotations
@volatile()
val adminPort: Flag[InetSocketAddress]
Definition Classes
AdminHttpServer
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
def allowUndefinedFlags: Boolean
Attributes
protected
Definition Classes
App
def args: Array[String]
Definition Classes
App
final def asInstanceOf[T0]: T0
Definition Classes
Any
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
See also
Awaitable)
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
See also
Awaiting Awaitables
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
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def close(deadline: Time): Future[Unit]
Definition Classes
CloseOnce → Closable
def close(after: Duration): Future[Unit]
Definition Classes
Closable
final def close(): Future[Unit]
Definition Classes
Closable
final def closeFuture: Future[Unit]
Attributes
protected
Definition Classes
CloseOnce
final def closeOnExit(closable: Closable): Unit
Definition Classes
App
final def closeOnExitLast(closable: Closable): Unit
Definition Classes
App
def closeOnce(deadline: Time): Future[Unit]
Attributes
protected
Definition Classes
App → CloseOnce
def configureAdminHttpServer(server: Server): Server
Attributes
protected
Definition Classes
AdminHttpServer
def debug(marker: Marker, message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def debug(message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def debug(marker: Marker, message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def debug(message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def debugResult[T](message: => String)(fn: => T): T
Attributes
protected[this]
Definition Classes
Logging
def defaultAdminPort: Int
Definition Classes
AdminHttpServer
def defaultCloseGracePeriod: Duration
Definition Classes
App
def disableAdminHttpServer: Boolean
Attributes
protected
Definition Classes
AdminHttpServer
val dtabAddBaseFlag: Flag[Dtab]
Definition Classes
DtabFlags
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def error(marker: Marker, message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def error(message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def error(marker: Marker, message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def error(message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def errorResult[T](message: => String)(fn: => T): T
Attributes
protected[this]
Definition Classes
Logging
def exitOnError(reason: String, details: => String): Unit
Attributes
protected
Definition Classes
App
def exitOnError(reason: String): Unit
Attributes
protected
Definition Classes
App
def exitOnError(throwable: Throwable): Unit
Attributes
protected
Definition Classes
App
def failfastOnFlagsNotParsed: Boolean
<invalid inheritdoc annotation>
<invalid inheritdoc annotation>
Attributes
protected
Definition Classes
App → App
Note
It is HIGHLY recommended that this value remains 'true'. This value SHOULD NOT be changed to 'false' without a very good reason.This method only remains overridable for legacy reasons.
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def flag: app.Flags
Definition Classes
App
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
val group: String
Definition Classes
Lifecycle
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
See also
com.twitter.inject.utils.Handler
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
See also
com.twitter.inject.utils.Handler
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
def httpExternalPort: Option[Int]
Returns the bound port representing the external HTTP interface of this server.
Returns the bound port representing the external HTTP interface of this server.
returns
a defined Some(Int) representing the port of the external HTTP interface if defined and bound, None otherwise.
Definition Classes
Ports
def httpsExternalPort: Option[Int]
Returns the bound port representing the external HTTPS interface of this server.
Returns the bound port representing the external HTTPS interface of this server.
returns
a defined Some(Int) representing the port of the external HTTPS interface if defined and bound, None otherwise.
Definition Classes
Ports
def includeGlobalFlags: Boolean
Attributes
protected
Definition Classes
App
def info(marker: Marker, message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def info(message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def info(marker: Marker, message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def info(message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def infoResult[T](message: => String)(fn: => T): T
Attributes
protected[this]
Definition Classes
Logging
final def init(f: => Unit): Unit
Attributes
protected
Definition Classes
App
def injector: Injector
Definition Classes
App
final def isClosed: Boolean
Definition Classes
CloseOnce
def isDebugEnabled(marker: Marker): Boolean
Attributes
protected[this]
Definition Classes
Logging
def isDebugEnabled: Boolean
Attributes
protected[this]
Definition Classes
Logging
def isErrorEnabled(marker: Marker): Boolean
Attributes
protected[this]
Definition Classes
Logging
def isErrorEnabled: Boolean
Attributes
protected[this]
Definition Classes
Logging
def isInfoEnabled(marker: Marker): Boolean
Attributes
protected[this]
Definition Classes
Logging
def isInfoEnabled: Boolean
Attributes
protected[this]
Definition Classes
Logging
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def isReady(implicit permit: CanAwait): Boolean
Definition Classes
CloseOnceAwaitably0 → Awaitable
def isTraceEnabled(marker: Marker): Boolean
Attributes
protected[this]
Definition Classes
Logging
def isTraceEnabled: Boolean
Attributes
protected[this]
Definition Classes
Logging
def isWarnEnabled(marker: Marker): Boolean
Attributes
protected[this]
Definition Classes
Logging
def isWarnEnabled: Boolean
Attributes
protected[this]
Definition Classes
Logging
def javaModules: Collection[Module]
Production modules from Java.
Production modules from Java.
Attributes
protected
Definition Classes
App
def javaOverrideModules: Collection[Module]
ONLY INTENDED FOR USE IN TESTING.
ONLY INTENDED FOR USE IN TESTING.
Override modules from Java which redefine production bindings (only use overrideModules during testing) If you think you need this in your main server you are most likely doing something incorrectly.
Attributes
protected
Definition Classes
App
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
def linterRules: Seq[Rule]
Definition Classes
Linters
def loadModules(): InstalledModules
ONLY INTENDED FOR USE BY THE FRAMEWORK.
ONLY INTENDED FOR USE BY THE FRAMEWORK.
Attributes
protected[inject]
Definition Classes
App
def loadServiceBindings: Seq[Binding[_]]
Attributes
protected[this]
Definition Classes
App
final def logger: Logger
Attributes
protected[this]
Definition Classes
Logging
final def loggerName: String
Attributes
protected[this]
Definition Classes
Logging
final def main(): Unit
DO NOT BLOCK
DO NOT BLOCK
Definition Classes
TwitterServer → App
final def main(args: Array[String]): Unit
Definition Classes
App
def modules: Seq[Module]
Production modules.
Production modules.
Attributes
protected
Definition Classes
App
Note
Java users should prefer javaModules.
def name: String
Definition Classes
App
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def nonExitingMain(args: Array[String]): Unit
Definition Classes
App
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def observe(event: Event)(f: => Unit): Unit
Attributes
protected
Definition Classes
Lifecycle
final def observeFuture(event: Event)(f: Future[Unit]): Future[Unit]
Attributes
protected
Definition Classes
Lifecycle
final def onExit(f: => Unit): Unit
Attributes
protected
Definition Classes
App
final def onExitLast(f: => Unit): Unit
Attributes
protected
Definition Classes
App
def overrideModules: Seq[Module]
ONLY INTENDED FOR USE IN TESTING.
ONLY INTENDED FOR USE IN TESTING.
Override modules which redefine production bindings (only use overrideModules during testing) If you think you need this in your main server you are most likely doing something incorrectly.
Attributes
protected
Definition Classes
App
def parseArgs(args: Array[String]): Unit
Attributes
protected[this]
Definition Classes
App
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.
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.
final def postmain(f: => Unit): Unit
Attributes
protected
Definition Classes
App
def prebindWarmup(): Unit
Definition Classes
Warmup
final def premain(f: => Unit): Unit
Attributes
protected
Definition Classes
App
def ready(timeout: Duration)(implicit permit: CanAwait): TwitterServer.this.type
Definition Classes
CloseOnceAwaitably0 → Awaitable
def resolveFinagleClientsOnStartup: Boolean
Resolve all Finagle clients before warmup method called
Resolve all Finagle clients before warmup method called
Attributes
protected
def result(timeout: Duration)(implicit permit: CanAwait): Unit
Definition Classes
CloseOnceAwaitably0 → Awaitable
def routes: Seq[Route]
Definition Classes
AdminHttpServer
final def run(): Unit
Attributes
protected
Definition Classes
TwitterServer → App
See also
com.twitter.inject.server.TwitterServer#start
final def runOnExit(runnable: Runnable): Unit
Attributes
protected
Definition Classes
App
final def runOnExitLast(runnable: Runnable): Unit
Attributes
protected
Definition Classes
App
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
lazy val shutdownTimer: Timer
Attributes
protected
Definition Classes
TwitterServer → App
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
def startAdminHttpServer(): Unit
Attributes
protected
Definition Classes
AdminHttpServer
final def startupCompletionEvent: Event
Attributes
protected[twitter]
Definition Classes
TwitterServer → Warmup → TwitterServer
def statsReceiver: StatsReceiver
Definition Classes
Stats
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
final val suppressGracefulShutdownErrors: Boolean
Definition Classes
TwitterServer → App
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def thriftPort: Option[Int]
Returns the bound port representing the external Thrift interface of this server.
Returns the bound port representing the external Thrift interface of this server.
returns
a defined Some(Int) representing the port of the external Thrift interface if defined and bound, None otherwise.
Definition Classes
Ports
def toString(): String
Definition Classes
AnyRef → Any
def trace(marker: Marker, message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def trace(message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def trace(marker: Marker, message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def trace(message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def traceResult[T](message: => String)(fn: => T): T
Attributes
protected[this]
Definition Classes
Logging
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
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
def warmupComplete(): Unit
Definition Classes
Warmup
def warn(marker: Marker, message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def warn(message: => Any, cause: Throwable): Unit
Attributes
protected[this]
Definition Classes
Logging
def warn(marker: Marker, message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def warn(message: => Any): Unit
Attributes
protected[this]
Definition Classes
Logging
def warnResult[T](message: => String)(fn: => T): T
Attributes
protected[this]
Definition Classes
Logging

Packages

TwitterServer

trait TwitterServer extends App with server.TwitterServer with Ports with Warmup

Value Members

Inherited from Warmup

Value Members

Inherited from Ports

Value Members

Inherited from server.TwitterServer

Value Members

Inherited from Lifecycle

Value Members

Inherited from AdminHttpServer

Value Members

Inherited from DtabFlags

Value Members

Inherited from Linters

Value Members

Inherited from Stats

Value Members

Inherited from App

Value Members

Inherited from util.logging.Logging

Value Members

Inherited from App

Value Members

Inherited from Lifecycle

Value Members

Inherited from CloseOnceAwaitably0[Unit]

Value Members

Inherited from CloseOnce

Value Members

Inherited from Closable

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Ungrouped

TwitterServer