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.

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 mysql

Definition Classes: finagle

package param

Definition Classes: mysql

package transport

Definition Classes: mysql

BigDecimalValue

BigIntTooLongException

BigIntValue

ByteValue

CanBeParameter

Capability

Client

CloseRequest

CloseStatementOK

ColumnNotFoundException

Command

CommandRequest

CursorResult

CursoredStatement

DateValue

Decoder

DoubleValue

EOF

EmptyValue

Error

ExecuteRequest

FetchRequest

FetchResult

Field

FieldAttributes

FloatValue

HandshakeInit

HandshakeResponse

IncompatibleCharset

IncompatibleServerError

IncompatibleVersion

IntValue

IsolationLevel

LongValue

LostSyncException

MysqlCharset

NullValue

Parameter

Parameters

PingRequest

PrepareOK

PrepareRequest

PreparedStatement

QueryRequest

QuitRequest

RawValue

Request

Result

ResultSet

RollbackFactory

Row

ServerError

ServerStatus

Session

ShortValue

SimpleCommandRequest

StringValue

TimestampValue

Transactions

Type

UnsupportedTypeException

UseRequest

Value

WithSql

com.twitter.finagle.mysql

Parameter

Companion object Parameter

sealed trait Parameter extends AnyRef

A value of type A can implicitly convert to a Parameter if an evidence CanBeParameter[A] is available in scope via the Parameter.wrap or Parameter.wrapOption implicits. Explicit conversions are available via Parameter.of and Parameters.of.

A Scala example with implicits:

import com.twitter.finagle.mysql.Parameter
import com.twitter.finagle.mysql.Parameter._

val p: Parameter = "this will get implicitly converted to a Parameter"

A Scala example without implicits:

import com.twitter.finagle.mysql.Parameter

val p: Parameter = Parameter.of("explicitly converted to a Parameter")

A Java example:

import com.twitter.finagle.mysql.Parameter;
import com.twitter.finagle.mysql.Parameters;

Parameter p = Parameters.of("explicitly converted to a Parameter");

Linear Supertypes

AnyRef, Any

Known Subclasses

NullParameter

Ordering

Alphabetic
By Inheritance

Inherited

Parameter
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

abstract type A

Abstract Value Members

abstract def evidence: CanBeParameter[A]
abstract def value: A

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@native() @throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def size: Int
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def typeCode: Short
final def wait(): Unit

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

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@native() @throws( ... )
final def writeTo(writer: MysqlBufWriter): Unit

Packages

Parameter

Companion object Parameter

sealed trait Parameter extends AnyRef

Type Members

Abstract Value Members

Concrete Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Parameter 

Companion object Parameter

sealed trait Parameter extends AnyRef

Type Members

Abstract Value Members

Concrete Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Parameter