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.

    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 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 pushsession
    Definition Classes
    exp
  • PushChannelHandle
  • PushListener
  • PushSession
  • PushStackClient
  • PushStackServer
  • PushTransporter
t

com.twitter.finagle.exp.pushsession

PushChannelHandle

trait PushChannelHandle[In, Out] extends Closable with ClientConnection

Abstraction for interacting with the underlying I/O pipeline.

The ChannelHandle provides tools for writing messages to the peer, an Executor which provides single threaded behavior for executed tasks, and information about the peer and state of the pipeline.

All method calls on the ChannelHandle are guaranteed not to result in re-entrance into the PushSession so long as these methods are called from within the serialExecutor. Specifically, if a session invokes a method on the handle it will not result in a new event reaching the session before the method call has returned. This avoids situations such as a session performing a write and before the call returns a new inbound message arrives and mutates session state in an unexpected way.

All failures are fatal to the PushChannelHandle including write failures. Specifically, any failure results in the onClose promise being completed with the exception in the Throw pathway and the underlying socket will be closed.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PushChannelHandle
  2. ClientConnection
  3. Closable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def close(deadline: Time): Future[Unit]
    Definition Classes
    Closable
  2. abstract def localAddress: SocketAddress

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

    Host/port of the local side of a client connection. This is only available after Service#connected has been signalled.

    Definition Classes
    ClientConnection
  3. abstract def onClose: Future[Unit]

    Expose a Future[Unit] that will be filled when the connection is closed Useful if you want to trigger action on connection closing

    Expose a Future[Unit] that will be filled when the connection is closed Useful if you want to trigger action on connection closing

    Definition Classes
    ClientConnection
  4. abstract def peerCertificate: Option[Certificate]

    Security certificate of the peer

  5. abstract 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.

    Note

    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.

    ,

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

  6. abstract def remoteAddress: SocketAddress

    Host/port of the client.

    Host/port of the client. This is only available after Service#connected has been signalled.

    Definition Classes
    ClientConnection
  7. abstract 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.

    Note

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

  8. abstract 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.

    Note

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

  9. abstract 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).

  10. abstract 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).

  11. abstract 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.

  12. abstract def status: Status

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

Concrete 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. def close(after: Duration): Future[Unit]
    Definition Classes
    Closable
  7. final def close(): Future[Unit]
    Definition Classes
    Closable
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from ClientConnection

Inherited from Closable

Inherited from AnyRef

Inherited from Any

Ungrouped