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 netty3

    Package netty3 implements the bottom finagle primitives: {{com.twitter.finagle.Server}} and a client transport in terms of the netty3 event loop.

    Package netty3 implements the bottom finagle primitives: {{com.twitter.finagle.Server}} and a client transport in terms of the netty3 event loop.

    Note: when {{com.twitter.finagle.builder.ClientBuilder}} and {{com.twitter.finagle.builder.ServerBuilder}} are deprecated, package netty3 can move into its own package, so that only the (new-style) clients and servers that depend on netty3 bring it in.

    Definition Classes
    finagle
  • package channel
    Definition Classes
    netty3
  • package http
    Definition Classes
    netty3
  • package socks
    Definition Classes
    netty3
  • package transport
    Definition Classes
    netty3
  • BufChannelBuffer
  • BufChannelBufferFactory
  • ChannelBufferBuf
  • ChannelBufferSnooper
  • ChannelSnooper
  • Netty3Listener
  • Netty3Transporter
  • SimpleChannelSnooper
  • numWorkers

class ChannelBufferBuf extends Buf

A com.twitter.io.Buf wrapper for Netty ChannelBuffers.

Note

Since ChannelBuffers are mutable, modifying the wrapped buffer within slices of a ChannelBufferBuf will modify the original wrapped ChannelBuffer. Similarly, modifications to the original buffer will be reflected in slices.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ChannelBufferBuf
  2. Buf
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ChannelBufferBuf(underlying: ChannelBuffer)

    underlying

    The org.jboss.netty.buffer.ChannelBuffer to be wrapped in a com.twitter.io.Buf interface.

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 checkWriteArgs(outputLen: Int, outputOff: Int): Unit
    Attributes
    protected[this]
    Definition Classes
    Buf
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. def computeHashCode: Int
    Attributes
    protected
    Definition Classes
    Buf
  8. final def concat(right: Buf): Buf
    Definition Classes
    Buf
  9. def copiedByteArray: Array[Byte]
    Attributes
    protected
    Definition Classes
    Buf
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(other: Any): Boolean
    Definition Classes
    ChannelBufferBuf → Buf → AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def get(index: Int): Byte
    Definition Classes
    ChannelBufferBuf → Buf
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def hashCode(): Int
    Definition Classes
    Buf → AnyRef → Any
  16. def isEmpty: Boolean
    Definition Classes
    Buf
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def isSliceEmpty(from: Int, until: Int): Boolean
    Attributes
    protected[this]
    Definition Classes
    Buf
  19. def isSliceIdentity(from: Int, until: Int): Boolean
    Attributes
    protected[this]
    Definition Classes
    Buf
  20. def length: Int
    Definition Classes
    ChannelBufferBuf → Buf
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def process(from: Int, until: Int, processor: Processor): Int
    Definition Classes
    ChannelBufferBuf → Buf
  25. def process(processor: Processor): Int
    Definition Classes
    Buf
  26. def slice(i: Int, j: Int): Buf
    Definition Classes
    ChannelBufferBuf → Buf
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    ChannelBufferBuf → AnyRef → Any
  29. val underlying: ChannelBuffer
    Attributes
    protected
  30. def unsafeByteArray: Array[Byte]
    Attributes
    protected
    Definition Classes
    Buf
  31. def unsafeByteArrayBuf: Option[ByteArray]
    Attributes
    protected
    Definition Classes
    ChannelBufferBuf → Buf
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  35. def write(buffer: ByteBuffer): Unit
    Definition Classes
    ChannelBufferBuf → Buf
  36. def write(bytes: Array[Byte], off: Int): Unit
    Definition Classes
    ChannelBufferBuf → Buf

Inherited from Buf

Inherited from AnyRef

Inherited from Any

Ungrouped