com.twitter.finagle.ThriftMuxClient.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of finagle-thriftmux_2.11 Show documentation
finagle-thriftmux
There is a newer version: 6.39.0
Show newest version
package com.twitter.finagle

import com.twitter.finagle.client.StackBasedClient
import com.twitter.finagle.param.{Label, Stats}
import com.twitter.finagle.thrift.{ClientId, ThriftClientRequest}
import org.apache.thrift.protocol.TProtocolFactory

/**
 * A [[com.twitter.finagle.Client]] for the Thrift protocol served over
 * [[com.twitter.finagle.mux]]. This class can't be instantiated. For a default
 * instance of ThriftMuxClientLike, see [[com.twitter.finagle.ThriftMuxClient]].
 */
@deprecated("Use object ThriftMux", "7.0.0")
class ThriftMuxClientLike private[finagle](client: ThriftMux.Client)
  extends StackBasedClient[ThriftClientRequest, Array[Byte]]
    with Stack.Parameterized[ThriftMuxClientLike]
    with Stack.Transformable[ThriftMuxClientLike]
    with ThriftRichClient
{
  /**
   * Used for Java access.
   */
  def get() = this

  /**
   * The [[com.twitter.finagle.ServiceFactory]] stack that requests
   * are dispatched through.
   */
  def stack = client.stack

  /**
   * The [[com.twitter.finagle.Stack.Params]] used to configure
   * the stack.
   */
  def params: Stack.Params = client.params

  protected val Thrift.param.ProtocolFactory(protocolFactory) =
    client.params[Thrift.param.ProtocolFactory]

  protected lazy val Label(defaultClientName) = params[Label]

  override protected lazy val Stats(stats) = params[Stats]

  /**
   * Create a new ThriftMuxClientLike with `params` used to configure the
   * muxer. This makes `ThriftMuxClientLike` compatible with the legacy
   * [[com.twitter.finagle.builder.ClientBuilder]]. However, keep in mind
   * that many of the ClientBuilder parameters are not applicable to the
   * muxer.
   */
  def apply(params: Stack.Params): Client[ThriftClientRequest, Array[Byte]] =
    new ThriftMuxClientLike(client.withParams(this.params ++ params))

  /**
   * Create a new ThriftMuxClientLike with `p` added to the
   * parameters used to configure the `muxer`.
   */
  override def configured[P: Stack.Param](p: P): ThriftMuxClientLike = super.configured(p)
  override def configured[P](psp: (P, Stack.Param[P])): ThriftMuxClientLike = super.configured(psp)

  def withParams(ps: Stack.Params): ThriftMuxClientLike =
    new ThriftMuxClientLike(client.withParams(ps))

  def transformed(t: Stack.Transformer): ThriftMuxClientLike =
    new ThriftMuxClientLike(client.transformed(t))

  /**
   * Produce a [[com.twitter.finagle.ThriftMuxClientLike]] using the provided
   * client ID.
   */
  def withClientId(clientId: ClientId): ThriftMuxClientLike =
    new ThriftMuxClientLike(client.withClientId(clientId))

  /**
   * Produce a [[com.twitter.finagle.ThriftMuxClientLike]] using the provided
   * protocolFactory.
   */
  def withProtocolFactory(pf: TProtocolFactory): ThriftMuxClientLike =
    new ThriftMuxClientLike(client.withProtocolFactory(pf))

  def newService(dest: Name, label: String): Service[ThriftClientRequest, Array[Byte]] =
    client.newService(dest, label)

  def newClient(dest: Name, label: String): ServiceFactory[ThriftClientRequest, Array[Byte]] =
    client.newClient(dest, label)
}

/**
 * A client for thrift served over [[com.twitter.finagle.mux]]
 *
 * $clientExample
 *
 * @define clientExampleObject ThriftMuxClient
 */
@deprecated("Use object ThriftMux", "7.0.0")
object ThriftMuxClient extends ThriftMuxClientLike(ThriftMux.client)