Packages

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

    Start with com.twitter.finagle.

    Definition Classes
    com
  • package finagle

    Finagle is an extensible RPC system.

    Finagle is an extensible RPC system.

    Services are represented by class com.twitter.finagle.Service. Clients make use of com.twitter.finagle.Service objects while servers implement them.

    Finagle contains a number of protocol implementations; each of these implement Client and/or com.twitter.finagle.Server. For example, Finagle's HTTP implementation, com.twitter.finagle.Http (in package finagle-http), exposes both.

    Thus a simple HTTP server is built like this:

    import com.twitter.finagle.{Http, Service}
    import com.twitter.finagle.http.{Request, Response}
    import com.twitter.util.{Await, Future}
    
    val service = new Service[Request, Response] {
      def apply(req: Request): Future[Response] =
        Future.value(Response())
    }
    val server = Http.server.serve(":8080", service)
    Await.ready(server)

    We first define a service to which requests are dispatched. In this case, the service returns immediately with a HTTP 200 OK response, and with no content.

    This service is then served via the Http protocol on TCP port 8080. Finally we wait for the server to stop serving.

    We can now query our web server:

    % curl -D - localhost:8080
    HTTP/1.1 200 OK

    Building an HTTP client is also simple. (Note that type annotations are added for illustration.)

    import com.twitter.finagle.{Http, Service}
    import com.twitter.finagle.http.{Request, Response}
    import com.twitter.util.{Future, Return, Throw}
    
    val client: Service[Request, Response] = Http.client.newService("localhost:8080")
    val f: Future[Response] = client(Request()).respond {
      case Return(rep) =>
        printf("Got HTTP response %s\n", rep)
      case Throw(exc) =>
        printf("Got error %s\n", exc)
    }

    Http.client.newService("localhost:8080") constructs a new com.twitter.finagle.Service instance connected to localhost TCP port 8080. We then issue a HTTP/1.1 GET request to URI "/". The service returns a com.twitter.util.Future representing the result of the operation. We listen to this future, printing an appropriate message when the response arrives.

    The Finagle homepage contains useful documentation and resources for using Finagle.

    Definition Classes
    twitter
  • package builder
    Definition Classes
    finagle
  • ClientBuilder
  • ClientConfig
  • ClientConfigEvidence
  • IncompleteSpecification
  • Server
  • ServerBuilder
  • ServerConfig
  • ServerConfigEvidence
  • SourceTrackingMonitor

trait Server extends ListeningServer

A listening server. This is for compatibility with older code that is using builder.Server. New code should use the ListeningServer trait.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Server
  2. ListeningServer
  3. Awaitable
  4. Closable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def boundAddress: SocketAddress

    The address to which this server is bound.

    The address to which this server is bound.

    Definition Classes
    ListeningServer
  2. abstract def closeServer(deadline: Time): Future[Unit]
    Attributes
    protected
    Definition Classes
    ListeningServer
  3. abstract def isReady(implicit permit: CanAwait): Boolean
    Definition Classes
    Awaitable
  4. abstract def ready(timeout: Duration)(implicit permit: CanAwait): Server.this.type
    Definition Classes
    Awaitable
    Annotations
    @throws( ... ) @throws( ... )
  5. abstract def result(timeout: Duration)(implicit permit: CanAwait): Unit
    Definition Classes
    Awaitable
    Annotations
    @throws( classOf[java.lang.Exception] )

Concrete 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. def announce(addr: String): Future[Announcement]

    Announce the given address and return a future to the announcement

    Announce the given address and return a future to the announcement

    Definition Classes
    ListeningServer
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. final def close(deadline: Time): Future[Unit]
    Definition Classes
    ListeningServer → Closable
  8. def close(after: Duration): Future[Unit]
    Definition Classes
    Closable
  9. final def close(): Future[Unit]
    Definition Classes
    Closable
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. lazy val set: Var[Set[SocketAddress]]
    Attributes
    protected[com.twitter.finagle]
    Definition Classes
    ListeningServer
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Deprecated Value Members

  1. final def localAddress: SocketAddress

    When a server is bound to an ephemeral port, gets back the address with concrete listening port picked.

    When a server is bound to an ephemeral port, gets back the address with concrete listening port picked.

    Annotations
    @deprecated
    Deprecated

    (Since version 2014-12-19) Use boundAddress

Inherited from ListeningServer

Inherited from Awaitable[Unit]

Inherited from Closable

Inherited from AnyRef

Inherited from Any

Ungrouped