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 pushsession
    Definition Classes
    finagle
  • PipeliningClientPushSession
  • PushChannelHandle
  • PushChannelHandleProxy
  • PushListener
  • PushSession
  • PushStackClient
  • PushStackServer
  • PushTransporter
  • RefPushSession
c

com.twitter.finagle.pushsession

PushChannelHandleProxy

abstract class PushChannelHandleProxy[In, Out] extends PushChannelHandle[In, Out]

Base proxy implementation for PushChannelHandle

Implementations should override methods as appropriate.

Linear Supertypes
PushChannelHandle[In, Out], ClientConnection, Closable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PushChannelHandleProxy
  2. PushChannelHandle
  3. ClientConnection
  4. Closable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PushChannelHandleProxy(underlying: PushChannelHandle[In, Out])

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def close(deadline: Time): Future[Unit]
    Definition Classes
    PushChannelHandleProxy → Closable
  7. def close(after: Duration): Future[Unit]
    Definition Classes
    Closable
  8. final def close(): Future[Unit]
    Definition Classes
    Closable
  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 localAddress: SocketAddress

    Host/port of the local side of a client connection.

    Host/port of the local side of a client connection.

    Definition Classes
    PushChannelHandleProxy → ClientConnection
  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. def onClose: Future[Unit]

    Expose a Future that is satisfied when the connection is closed.

    Expose a Future that is satisfied when the connection is closed.

    Definition Classes
    PushChannelHandleProxy → ClientConnection
  20. def registerSession(newSession: PushSession[In, Out]): Unit

    Replaces the current PushSession, directing inbound events to the new session.

    Replaces the current PushSession, directing inbound events to the new session.

    Definition Classes
    PushChannelHandleProxy → PushChannelHandle
    Note

    It is unsafe to register a new session from outside of serial executor and to do so will result in undefined behavior.

    ,

    other than no longer receiving inbound messages, the previous session is still active and it is the responsibility of the caller to release any resources held by the previous session.

  21. def remoteAddress: SocketAddress

    Host/port of the client.

    Host/port of the client.

    Definition Classes
    PushChannelHandleProxy → ClientConnection
  22. def send(message: Out)(onComplete: (Try[Unit]) => Unit): Unit

    Write a message to the underlying IO pipeline.

    Write a message to the underlying IO pipeline.

    Definition Classes
    PushChannelHandleProxy → PushChannelHandle
    Note

    the provided continuation is guaranteed to be executed later, meaning that this method call will return before onComplete is run.

  23. def send(messages: Iterable[Out])(onComplete: (Try[Unit]) => Unit): Unit

    Write multiple messages to the underlying IO pipeline.

    Write multiple messages to the underlying IO pipeline.

    Definition Classes
    PushChannelHandleProxy → PushChannelHandle
    Note

    the provided continuation is guaranteed to be executed later, meaning that this method call will return before onComplete is run.

  24. def sendAndForget(messages: Iterable[Out]): Unit

    Write a collection of messages to the underlying IO pipeline.

    Write a collection of messages to the underlying IO pipeline.

    Any errors in writing result in closing the pipeline and are propagated through the onClose Future (provided it has not yet resolved).

    Definition Classes
    PushChannelHandleProxy → PushChannelHandle
  25. def sendAndForget(message: Out): Unit

    Write a message to the underlying IO pipeline.

    Write a message to the underlying IO pipeline.

    Any errors in writing result in closing the pipeline and are propagated through the onClose Future (provided it has not yet resolved).

    Definition Classes
    PushChannelHandleProxy → PushChannelHandle
  26. def serialExecutor: Executor

    Single threaded executor meaning that every computation is run sequentially and provides a happens-before relationship with respect to every other computation executed by the Executor.

    Single threaded executor meaning that every computation is run sequentially and provides a happens-before relationship with respect to every other computation executed by the Executor. Messages from the pipeline are guaranteed to be processed in this Executor.

    Definition Classes
    PushChannelHandleProxy → PushChannelHandle
  27. def sslSessionInfo: SslSessionInfo

    SSL/TLS session information associated with the push channel handle.

    SSL/TLS session information associated with the push channel handle.

    Definition Classes
    PushChannelHandleProxy → PushChannelHandle → ClientConnection
    Note

    If SSL/TLS is not being used a NullSslSessionInfo will be returned instead.

  28. def status: Status

    The status of this transport; see com.twitter.finagle.Status for status definitions.

    The status of this transport; see com.twitter.finagle.Status for status definitions.

    Definition Classes
    PushChannelHandleProxy → PushChannelHandle
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from PushChannelHandle[In, Out]

Inherited from ClientConnection

Inherited from Closable

Inherited from AnyRef

Inherited from Any

Ungrouped