Trait/Object

com.twitter.finagle.transport

Transport

Related Docs: object Transport | package transport

Permalink

trait Transport[In, Out] extends Closable

A transport is a representation of a stream of objects that may be read from and written to asynchronously. Transports are connected to some endpoint, typically via a channel pipeline that performs encoding and decoding.

Self Type
Transport[In, Out]
Linear Supertypes
Closable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Transport
  2. Closable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Context <: TransportContext

    Permalink

Abstract Value Members

  1. abstract def close(deadline: Time): Future[Unit]

    Permalink
    Definition Classes
    Closable
  2. abstract def context: Context

    Permalink

    The control panel for the Transport.

  3. abstract def read(): Future[Out]

    Permalink

    Read a message from the transport.

  4. abstract def write(req: In): Future[Unit]

    Permalink

    Write req to this transport; the returned future acknowledges write completion.

  5. abstract def localAddress: SocketAddress

    Permalink

    The locally bound address of this transport.

    The locally bound address of this transport.

    Annotations
    @deprecated
    Deprecated

    (Since version 2017-08-21) Please use Transport.context.localAddress instead

  6. abstract def onClose: Future[Throwable]

    Permalink

    The channel closed with the given exception.

    The channel closed with the given exception. This is the same exception you would get if attempting to read or write on the Transport, but this allows clients to listen to close events.

    Annotations
    @deprecated
    Deprecated

    (Since version 2017-08-21) Please use Transport.context.onClose instead

  7. abstract def peerCertificate: Option[Certificate]

    Permalink

    The peer certificate if a TLS session is established.

    The peer certificate if a TLS session is established.

    Annotations
    @deprecated
    Deprecated

    (Since version 2017-08-21) Please use Transport.context.peerCertificate instead

  8. abstract def remoteAddress: SocketAddress

    Permalink

    The remote address to which the transport is connected.

    The remote address to which the transport is connected.

    Annotations
    @deprecated
    Deprecated

    (Since version 2017-08-21) Please use Transport.context.remoteAddress instead

  9. abstract def status: Status

    Permalink

    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.

    Annotations
    @deprecated
    Deprecated

    (Since version 2017-08-21) Please use Transport.context.status instead

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

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

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

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

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def close(after: Duration): Future[Unit]

    Permalink
    Definition Classes
    Closable
  7. final def close(): Future[Unit]

    Permalink
    Definition Classes
    Closable
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. def map[In1, Out1](f: (In1) ⇒ In, g: (Out) ⇒ Out1): Transport[In1, Out1]

    Permalink

    Maps this transport to Transport[In1, Out2].

    Maps this transport to Transport[In1, Out2]. Note, exceptions in f and g are lifted to a com.twitter.util.Future.

    f

    The function applied to writes input.

    g

    The function applied to the result of a read

  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Closable

Inherited from AnyRef

Inherited from Any

Ungrouped