Packages

package root

Definition Classes: root

package com

Start with com.twitter.finagle.

Definition Classes: root

package twitter

Start with com.twitter.finagle.

Definition Classes: com

package finagle

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 addr

Definition Classes: finagle

package builder

Definition Classes: finagle

package client

Definition Classes: finagle

package context

Definition Classes: finagle

package core

Definition Classes: finagle

package dispatch

Definition Classes: finagle

package exp

Package exp contains experimental code.

Package exp contains experimental code. This can be removed or stabilized (moved elsewhere) at any time.

Definition Classes: finagle

package factory

Definition Classes: finagle

package filter

Definition Classes: finagle

package group

Definition Classes: finagle

package httpproxy

Definition Classes: finagle

package loadbalancer

Definition Classes: finagle

package namer

Definition Classes: finagle

package naming

Definition Classes: finagle

package netty3

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

package socks

package ssl

package transport

BufChannelBuffer

BufChannelBufferFactory

ChannelBufferBuf

ChannelBufferSnooper

ChannelSnooper

Netty3Listener

Netty3Transporter

SimpleChannelSnooper

numWorkers

package param

Defines common com.twitter.finagle.Stack.Param's shared between finagle clients and servers.

Definition Classes: finagle

package pool

Definition Classes: finagle

package server

Definition Classes: finagle

package service

Definition Classes: finagle

package socks

Definition Classes: finagle

package ssl

Definition Classes: finagle

package stats

Definition Classes: finagle

package thrift

Definition Classes: finagle

package tracing

Definition Classes: finagle

package transport

Definition Classes: finagle

package util

Definition Classes: finagle

com.twitter.finagle

netty3

package netty3

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

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

netty3
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

class ChannelBufferBuf extends Buf
A com.twitter.io.Buf wrapper for Netty ChannelBuffers.
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.
class ChannelBufferSnooper extends ChannelSnooper
Log message events
trait ChannelSnooper extends ChannelDownstreamHandler with ChannelUpstreamHandler
Log events on channels
class Netty3Listener [In, Out] extends Listener[In, Out]
A listener using Netty3 which is given a ChannelPipelineFactory that yields Out-typed upstream messages and accepts In-typed downstream messages.
A listener using Netty3 which is given a ChannelPipelineFactory that yields Out-typed upstream messages and accepts In-typed downstream messages.
In
the type of input messages
Out
the type of output messages
class Netty3Transporter [In, Out] extends (SocketAddress, StatsReceiver) ⇒ Future[Transport[In, Out]]
A transporter for netty3 which, given an endpoint name (socket address), provides a typed transport for communicating with this endpoint.
A transporter for netty3 which, given an endpoint name (socket address), provides a typed transport for communicating with this endpoint.
In
the type of requests. The given pipeline must consume Req-typed objects
Out
the type of replies. The given pipeline must produce objects of this type.
class SimpleChannelSnooper extends ChannelSnooper
Log raw channel events

Value Members

val Executor: ExecutorService
val WorkerPool: NioWorkerPool
object BufChannelBuffer
object BufChannelBufferFactory
Class BufChannelBufferFactory is a Netty ChannelBufferFactory that creates read-only ChannelBuffers based on Bufs.
Class BufChannelBufferFactory is a Netty ChannelBufferFactory that creates read-only ChannelBuffers based on Bufs. They are a thin API wrapper on top of Buf; no additional allocations are performed.
object ChannelBufferBuf
object ChannelSnooper
object Netty3Listener
object Netty3Transporter
object numWorkers extends GlobalFlag[Int]

Packages

netty3

package netty3

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

netty3 

package netty3

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

netty3