Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package twitter
    Definition Classes
    com
  • package server

    Provides a common configuration setup for internal Twitter servers based on com.twitter.app.App.

    Twitter Server

    Provides a common configuration setup for internal Twitter servers based on com.twitter.app.App.

    An HTTP server is bound to a configurable port (default: 9900) to which commands can be sent and information queried. Additional handlers can be provided by adding them to com.twitter.finagle.http.HttpMuxer.

    object MyServer extends TwitterServer {
  def main() {
    // start my service
  }
}

    Provided handlers

    See com.twitter.server.TwitterServer

    Configuration

    The default port is set via defaultAdminPort. This can be overridden in the super class or set on the command line with -admin.port.

    Definition Classes
    twitter
  • object AdminHttpServer
    Definition Classes
    server
  • Route

case class Route(path: String, handler: Service[Request, Response], alias: String, group: Option[String], includeInIndex: Boolean, method: Method = Method.Get) extends Product with Serializable

Represents an element which can be routed to via the admin http server.

path

The path used to access the route. A request is routed to the path as per the com.twitter.finagle.http.HttpMuxer spec.

handler

The service which requests are routed to.

alias

A short name used to identify the route when listed in index.

group

A grouping used to organize the route in the admin server pages. Routes with the same grouping are displayed together in the admin server pages.

includeInIndex

Indicates whether the route is included as part of the admin server index.

method

Specifies which HTTP Method to use from com.twitter.finagle.http.Method. The default is Method.Get.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Route
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Route(path: String, handler: Service[Request, Response], alias: String, group: Option[String], includeInIndex: Boolean, method: Method = Method.Get)

    path

    The path used to access the route. A request is routed to the path as per the com.twitter.finagle.http.HttpMuxer spec.

    handler

    The service which requests are routed to.

    alias

    A short name used to identify the route when listed in index.

    group

    A grouping used to organize the route in the admin server pages. Routes with the same grouping are displayed together in the admin server pages.

    includeInIndex

    Indicates whether the route is included as part of the admin server index.

    method

    Specifies which HTTP Method to use from com.twitter.finagle.http.Method. The default is Method.Get.

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. val alias: String
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. val group: Option[String]
  11. val handler: Service[Request, Response]
  12. val includeInIndex: Boolean
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. val method: Method
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. val path: String
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped