Packages

trait StackClient[Req, Rep] extends StackBasedClient[Req, Rep] with Parameterized[StackClient[Req, Rep]] with Transformable[StackClient[Req, Rep]]

A Client that composes a Stack.

Linear Supertypes
StackBasedClient[Req, Rep], Transformable[StackClient[Req, Rep]], Parameterized[StackClient[Req, Rep]], Client[Req, Rep], AnyRef, Any
Known Subclasses
Client, Client, Client, Client, Client, Client, Client, EndpointerStackClient, StdStackClient, PushStackClient
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StackClient
  2. StackBasedClient
  3. Transformable
  4. Parameterized
  5. Client
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def newClient(dest: Name, label: String): ServiceFactory[Req, Rep]

    Create a new client connected to dest.

    Create a new client connected to dest. See the user guide for details on destination names.

    Argument label is used to assign a label to this client. The label is used to display stats, etc.

    Definition Classes
    Client
  2. abstract def newService(dest: Name, label: String): Service[Req, Rep]

    Create a new service which dispatches requests to dest.

    Create a new service which dispatches requests to dest. See the user guide for details on destination names.

    Argument label is used to assign a label to this client. The label is used to display stats, etc.

    Definition Classes
    Client
  3. abstract def params: Params

    The current parameter map.

    The current parameter map.

    Definition Classes
    StackClient → Parameterized
  4. abstract def stack: Stack[ServiceFactory[Req, Rep]]

    The current stack.

  5. abstract def withParams(ps: Params): StackClient[Req, Rep]
    Definition Classes
    StackClient → Parameterized
  6. abstract def withStack(stack: Stack[ServiceFactory[Req, Rep]]): StackClient[Req, Rep]

    A new StackClient with the provided stack.

    A new StackClient with the provided stack.

    See also

    withStack that takes a Function1 for a more ergonomic API when used with method chaining.

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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def configured[P](psp: (P, Param[P])): StackClient[Req, Rep]

    Java friendly API for configured.

    Java friendly API for configured.

    The Tuple2 can often be created by calls to a mk(): (P, Stack.Param[P]) method on parameters (see com.twitter.finagle.loadbalancer.LoadBalancerFactory.Param.mk() as an example).

    Definition Classes
    Parameterized
  7. def configured[P](p: P)(implicit sp: Param[P]): StackClient[Req, Rep]

    Add the parameter, p, to the current Params.

    Add the parameter, p, to the current Params.

    Java users may find it easier to use the Tuple2 version below.

    Definition Classes
    Parameterized
  8. def configuredParams(newParams: Params): StackClient[Req, Rep]

    Adds all parameters, newParams, to the current Params.

    Adds all parameters, newParams, to the current Params.

    Definition Classes
    Parameterized
  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. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def newClient(dest: String, label: String): ServiceFactory[Req, Rep]

    Create a new client connected to dest.

    Create a new client connected to dest. See the user guide for details on destination names.

    Argument label is used to assign a label to this client. The label is used to display stats, etc.

    Definition Classes
    Client
  17. final def newClient(dest: String): ServiceFactory[Req, Rep]

    Create a new client connected to dest.

    Create a new client connected to dest. See the user guide for details on destination names.

    Definition Classes
    Client
  18. final def newService(dest: String, label: String): Service[Req, Rep]

    Create a new service which dispatches requests to dest.

    Create a new service which dispatches requests to dest. See the user guide for details on destination names.

    Definition Classes
    Client
  19. final def newService(dest: String): Service[Req, Rep]

    Create a new service which dispatches requests to dest.

    Create a new service which dispatches requests to dest. See the user guide for details on destination names.

    Definition Classes
    Client
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def registerTransporter(transporterName: String): Unit

    Export info about the transporter type so that we can query info about its implementation at runtime.

    Export info about the transporter type so that we can query info about its implementation at runtime.

    Attributes
    protected
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. def transformed(t: Stack.Transformer): StackClient[Req, Rep]

    Definition Classes
    StackClient → Transformable
    See also

    withStack

  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. def withStack(fn: (Stack[ServiceFactory[Req, Rep]]) => Stack[ServiceFactory[Req, Rep]]): StackClient[Req, Rep]

    A new StackClient using the function to create a new Stack.

    A new StackClient using the function to create a new Stack.

    The input to fn is the client's current stack. This API allows for easier usage when writing code that uses method chaining.

    This method is similar to transformed while providing easier API ergonomics for one-off Stack changes.

    Example:

    1. From Scala:

      import com.twitter.finagle.Http

Http.client.withStack(_.prepend(MyStackModule))

      From Java:

      import com.twitter.finagle.Http;
import static com.twitter.util.Function.func;

Http.client().withStack(func(stack -> stack.prepend(MyStackModule)));
    See also

    withStack(Stack)

    transformed

Inherited from StackBasedClient[Req, Rep]

Inherited from Transformable[StackClient[Req, Rep]]

Inherited from Parameterized[StackClient[Req, Rep]]

Inherited from Client[Req, Rep]

Inherited from AnyRef

Inherited from Any

Ungrouped