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 redis
    Definition Classes
    finagle
  • package exp
    Definition Classes
    redis
  • Channel
  • Pattern
  • RedisPool
  • SubscribeCommands
  • SubscribeDispatcher
  • SubscribeHandler
  • SubscriptionType

trait SubscribeCommands extends AnyRef

SubscribeClient is used to (un)subscribe messages from redis' PUB/SUB subsystem. Once a client enters PUB/SUB state by subscribing to some channel/pattern, it should not issue any other commands, except the (un)subscribe commands, until it exits from the PUB/SUB state, by unsubscribing from all the channels and patterns. For this reason, we put the (un)subscribe commands here, separately from the other ordinary commands.

Self Type
Client
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SubscribeCommands
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    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 pSubscribe(patterns: Seq[Buf])(handler: MessageHandler): Future[Map[Buf, Throwable]]

    Subscribe to patterns.

    Subscribe to patterns. Messages received from the subscribed patterns will be processed by the handler.

    A pattern will be subscribed to only once. Subscribing to an already subscribed pattern will be ignored. Although a Seq is passed in as argument, the patterns are subscribed to one by one, with individual commands, and when the client is connected to multiple server nodes, it is not guaranteed that they are subscribed to from the same node.

    When the Future returned by this method is completed, it is guaranteed that an attempt is made, to send a pSubscribe command for each of the patterns that is not subscribed to yet. And the failed subscriptions are returned as a map from the failed channel to the exception object. Subscriptions will be managed by the SubscriptionManager, even if it failed at the first attempt. In that case, subsequent attempts will be made regularly until the pattern is subscribed to successfully, or the subscription is cancelled by calling the pUnsubscribed method.

  16. def pUnsubscribe(patterns: Seq[Buf]): Future[Map[Buf, Throwable]]

    Unsubscribe from patterns.

    Unsubscribe from patterns. The subscriptions to the specified patterns are removed from the SubscriptionManager. An unsubscribe command is sent for each of the succeeded subscriptions, and the failed ones are returned as a Future of map from the pattern to the exception object.

  17. def subscribe(channels: Seq[Buf])(handler: MessageHandler): Future[Map[Buf, Throwable]]

    Subscribe to channels.

    Subscribe to channels. Messages received from the subscribed channels will be processed by the handler.

    A channel will be subscribed to only once. Subscribing to an already subscribed channel will be ignored. Although a Seq is passed in as argument, the channels are subscribed to one by one, with individual commands, and when the client is connected to multiple server nodes, it is not guaranteed that they are subscribed to from the same node.

    When the Future returned by this method is completed, it is guaranteed that an attempt is made, to send a subscribe command for each of the channels that is not subscribed to yet. And the failed subscriptions are returned as a map from the failed channel to the exception object. Subscriptions will be managed by the SubscriptionManager, even if it failed at the first attempt. In that case, subsequent attempts will be made regularly until the channel is subscribed to successfully, or the subscription is cancelled by calling the unsubscribed method.

  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. def unsubscribe(channels: Seq[Buf]): Future[Map[Buf, Throwable]]

    Unsubscribe from channels.

    Unsubscribe from channels. The subscriptions to the specified channels are removed from the SubscriptionManager. An unsubscribe command is sent for each of the succeeded subscriptions, and the failed ones are returned as a Future of map from the channel to the exception object.

  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped