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 postgresql
    Definition Classes
    finagle
  • package machine
    Definition Classes
    postgresql
  • CloseMachine
  • ExecuteMachine
  • HandshakeMachine
  • PrepareMachine
  • Runner
  • SimpleQueryMachine
  • StateMachine

object StateMachine

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StateMachine
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. sealed trait Action[+R <: Response] extends AnyRef

    Represents all the possible side effects that can occur when transitioning to a new state.

  2. case class Complete[R <: Response](ready: ReadyForQuery, response: Option[Try[R]]) extends TransitionResult[Nothing, R] with Product with Serializable

    Indicates that the state machine is finished and the connection may be released.

    Indicates that the state machine is finished and the connection may be released. Postgres uses the ReadyForQuery message to indicate this to the client, so it is expected to be provided here. Also, if completing the sate machine should also complete the client's response, then the value to produce can be provided in the response field. If the client's promise has already been fulfilled, this will have no effect.

    ready

    the ReadyForQuery message from the backend confirming the connection's state.

    response

    an optional value to used to fulfill the client's promise. If this is None, then the Respond action must have been produced during the state machine's lifecycle to guarantee the client receives a response.

  3. case class Respond[R <: Response](value: Try[R]) extends Action[R] with Product with Serializable

    Respond to the client's request.

    Respond to the client's request. This effectively completes the client's request, but will not release the connection yet.

    value

    the value used to fulfill the client's response promise.

  4. final case class Send[M <: FrontendMessage](msg: M) extends Action[Nothing] with Product with Serializable

    Send the specified FrontendMessage after transitioning to the new sate.

  5. final case class SendSeveral(msgs: FrontendMessage*) extends Action[Nothing] with Product with Serializable

    Send multiple messages to the backend after transitioning to the new sate.

    Send multiple messages to the backend after transitioning to the new sate. This allows sending multiple messages in a row without waiting for a message from the backend between each of them.

  6. case class Transition[S, R <: Response](state: S, action: Action[R]) extends TransitionResult[S, R] with Product with Serializable
  7. sealed trait TransitionResult[+S, +R <: Response] extends AnyRef

    The result of applying a message to a particular state.

    The result of applying a message to a particular state. This encapsulates the new state to transition to as well as possible side effects to produce.

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 def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  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. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. def singleMachine[M <: FrontendMessage, R <: Response](name: String, msg: M)(f: (ReadyForQuery) => R)(implicit arg0: MessageEncoder[M]): StateMachine[R]

    A machine that sends a single frontend message and expects a ReadyForQuery response

  16. val syncMachine: StateMachine[Ready.type]
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. case object NoOp extends Action[Nothing] with Product with Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped