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 http
    Definition Classes
    finagle
  • package collection
    Definition Classes
    http
  • final class RecordSchema extends AnyRef

    RecordSchema represents the declaration of a heterogeneous Record type, with Fields that are determined at runtime.

    RecordSchema represents the declaration of a heterogeneous Record type, with Fields that are determined at runtime. A Field declares the static type of its associated values, so although the record itself is dynamic, field access is type-safe.

    Given a RecordSchema declaration schema, any number of Records of that schema can be obtained with schema.newRecord. The type that Scala assigns to this value is what Scala calls a "path-dependent type," meaning that schema1.Record and schema2.Record name distinct types. The same is true of fields: schema1.Field[A] and schema2.Field[A] are distinct, and can only be used with the corresponding Record.

    Definition Classes
    collection
  • Field
  • Record

final class Record extends AnyRef

Record is an instance of a RecordSchema declaration. Records are mutable; the update method assigns or reassigns a value to a given field. If the user requires that a field's assigned value is never reassigned later, the user can lock that field.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Record
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. def apply[A](field: Field[A]): A

    Returns the current value assigned to field in this record.

    Returns the current value assigned to field in this record. If there is no value currently assigned (either explicitly by a previous update, or by the field's declared default), this will throw an IllegalStateException, indicating the field was never initialized.

    Note that Scala provides two syntactic equivalents for invoking this method:

    record.apply(field)
record(field)
    field

    the field to access in this record

    returns

    the value associated with field.

    Annotations
    @throws(classOf[IllegalStateException])
    Exceptions thrown
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def copy[A](field: Field[A], value: A): Record

    Create a copy of this record with value assigned to field.

    Create a copy of this record with value assigned to field. field will be locked in the copy if and only if it was present and locked in the original record. If field was not present in the original then the following are equivalent:

    record.copy(field, value)
record.copy().update(field, value)
    field

    the field to assign in the copy

    value

    the value to assign to field in the copy

    returns

    a copy of this record

  8. def copy(): Record

    Create a copy of this record.

    Create a copy of this record. Fields are locked in the copy if and only if they were locked in the original record.

    returns

    a copy of this record

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def lock(field: Field[_]): Record

    Locks the current value for a given field in this record, preventing further updates.

    Locks the current value for a given field in this record, preventing further updates. If there is no value currently assigned (either explicitly by a previous update, or by the field's declared default), this will throw an IllegalStateException, indicating the field was never initialized.

    field

    the field to lock in this record

    returns

    this record

    Annotations
    @throws(classOf[IllegalStateException])
    Exceptions thrown
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. def update[A](field: Field[A], value: A): Record

    Assigns (or reassigns) a value to a field in this record.

    Assigns (or reassigns) a value to a field in this record. If this field was previously locked, this will throw an IllegalStateException to indicate failure.

    Note that Scala provides two syntactic equivalents for invoking this method:

    record.update(field, value)
record(field) = value
    field

    the field to assign in this record

    value

    the value to assign to field in this record

    returns

    this record

    Annotations
    @throws(classOf[IllegalStateException])
    Exceptions thrown
  22. def updateAndLock[A](field: Field[A], value: A): Record

    Assigns (or reassigns) a value to a field in this record, and locks it to prevent further updates.

    Assigns (or reassigns) a value to a field in this record, and locks it to prevent further updates. This method is provided for convenience only; the following are equivalent:

    record.updateAndLock(field, value)
record.update(field, value).lock(field)
    field

    the field to assign and lock in this record

    value

    the value to assign to field in this record

    returns

    this record

    Annotations
    @throws(classOf[IllegalStateException])
    Exceptions thrown
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped