Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package twitter

    Start with com.twitter.finagle.

    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 mysql
    Definition Classes
    finagle
  • package param
    Definition Classes
    mysql
  • CachingSha2PasswordAuth
  • Charset
  • ConnectionInitRequest
  • Credentials
  • Database
  • FoundRows
  • MaxConcurrentPrepareStatements
  • PathToServerRsaPublicKey
  • UnsignedColumns
  • package transport
    Definition Classes
    mysql

package param

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class CachingSha2PasswordAuth(enabled: Boolean) extends Product with Serializable

    To configure the client to use the caching_sha2_password authentication method.

    To configure the client to use the caching_sha2_password authentication method. Needed to set the CLIENT_PLUGIN_AUTH capability flag during the handshake phase.

  2. case class Charset(charset: Short) extends Product with Serializable

    A class eligible for configuring a mysql client's charset during the Handshake phase.

  3. case class ConnectionInitRequest(request: Option[Request]) extends Product with Serializable

    A class eligible for configuring a initial request which used when establishing a new session.

  4. case class Credentials(username: Option[String], password: Option[String]) extends Product with Serializable

    A class eligible for configuring a mysql client's credentials during the Handshake phase.

  5. case class Database(db: Option[String]) extends Product with Serializable

    A class eligible for configuring a mysql client's database during the Handshake phase.

  6. case class FoundRows(enabled: Boolean) extends Product with Serializable

    A class eligible for configuring a mysql client's CLIENT_FOUND_ROWS flag during the Handshake phase.

  7. case class MaxConcurrentPrepareStatements(num: Int) extends Product with Serializable

    A class eligible for configuring the maximum number of prepare statements.

    A class eligible for configuring the maximum number of prepare statements. After creating num prepare statements, we'll start purging old ones.

  8. final case class PathToServerRsaPublicKey(path: String) extends Product with Serializable

    To configure the local path to the server's RSA public key.

    To configure the local path to the server's RSA public key. This is used during caching_sha2_password authentication when authenticating over a plaintext connection.

  9. case class UnsignedColumns(supported: Boolean) extends Product with Serializable

    Configure whether to support unsigned integer fields when returning elements of a Row.

    Configure whether to support unsigned integer fields when returning elements of a Row. If not supported, unsigned fields will be decoded as if they were signed, potentially resulting in corruption in the case of overflowing the signed representation. Because Java doesn't support unsigned integer types widening may be necessary to support the unsigned variants. For example, an unsigned Int is represented as a Long.

    Value representations of unsigned columns which are widened when enabled: ByteValue -> ShortValue ShortValue -> IntValue LongValue -> LongLongValue LongLongValue -> BigIntValue

Value Members

  1. object CachingSha2PasswordAuth extends Serializable
  2. object Charset extends Serializable
  3. object ConnectionInitRequest extends Serializable
  4. object Credentials extends Serializable
  5. object Database extends Serializable
  6. object FoundRows extends Serializable
  7. object MaxConcurrentPrepareStatements extends Serializable
  8. object PathToServerRsaPublicKey extends Serializable
  9. object UnsignedColumns extends Serializable

Ungrouped