t

com.twitter.scrooge

ThriftMethod

trait ThriftMethod extends ThriftMethodIface

Metadata for a method for a Thrift service.

Comments below will use this example IDL:

service ExampleService {
  i32 boringMethod(
    1: i32 input1,
    2: string input2
  )
}
Linear Supertypes
ThriftMethodIface, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ThriftMethod
  2. ThriftMethodIface
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type Args <: ThriftStruct

    A struct wrapping method arguments

    A struct wrapping method arguments

    For Scala generated code this will be a wrapper around all of the inputs. Roughly:

    class Args(input1: Int, input2: String) extends ThriftStruct
  2. abstract type FunctionType

    The type of this method, as a function.

    The type of this method, as a function.

    For Scala generated code with Finagle bindings this will be roughly:

    Function1[Args, Future[Int]]

    For Scala generated code without Finagle bindings, this will be Nothing.

  3. abstract type ReqRepFunctionType

    The type of this method, as a function.

    The type of this method, as a function.

    For Scala generated code with Finagle bindings this will be roughly:

    Function1[scrooge.Request[Args], Future[scrooge.Response[Int]]]

    For Scala generated code without Finagle bindings, this will be Nothing.

  4. abstract type ReqRepServicePerEndpointServiceType

    The type of this method, as a Finagle Service from scrooge.Request[Args] to scrooge.Response[SuccessType].

    The type of this method, as a Finagle Service from scrooge.Request[Args] to scrooge.Response[SuccessType].

    For Scala generated code with Finagle bindings this will be roughly: Service[scrooge.Request[Args], scrooge.Response[SuccessType]].

    For Scala generated code without Finagle bindings, this will be Nothing.

  5. abstract type Result <: ThriftResponse[SuccessType] with ThriftStruct

    Contains success or thrift application exceptions

  6. abstract type ServicePerEndpointServiceType

    The type of this method, as a Finagle Service from Args to SuccessType.

    The type of this method, as a Finagle Service from Args to SuccessType.

    For Scala generated code with Finagle bindings this will be roughly: Service[Args, SuccessType].

    For Scala generated code without Finagle bindings, this will be Nothing.

  7. abstract type SuccessType

    The successful return type

    The successful return type

    For Scala generated code this will be the response's type. Roughly:

    type SuccessType = Int

Abstract Value Members

  1. abstract def annotations: Map[String, String]

    Thrift annotations (user-defined key-value metadata) on the method

  2. abstract def argsCodec: ThriftStructCodec3[Args]

    Codec for the request args

  3. abstract def name: String

    Thrift method name

    Thrift method name

    Definition Classes
    ThriftMethodIface
  4. abstract def oneway: Boolean

    True for oneway thrift methods

  5. abstract def responseCodec: ThriftStructCodec3[Result]

    Codec for the response

  6. abstract def serviceName: String

    Thrift service name.

    Thrift service name. A thrift service is a list of methods.

    Definition Classes
    ThriftMethodIface
  7. abstract def toReqRepServicePerEndpointService(f: ReqRepFunctionType): ReqRepServicePerEndpointServiceType

    Convert a function implementation of this method into a ReqRepServicePerEndpoint Finagle Service implementation returning scrooge.Response[SuccessType].

    Convert a function implementation of this method into a ReqRepServicePerEndpoint Finagle Service implementation returning scrooge.Response[SuccessType].

    For Scala generated code without Finagle bindings, this will not implemented.

  8. abstract def toServicePerEndpointService(f: FunctionType): ServicePerEndpointServiceType

    Convert a function implementation of this method into a ServicePerEndpoint Finagle Service implementation returning SuccessType.

    Convert a function implementation of this method into a ServicePerEndpoint Finagle Service implementation returning SuccessType.

    For Scala generated code without Finagle bindings, this will not implemented.

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

Inherited from ThriftMethodIface

Inherited from AnyRef

Inherited from Any

Ungrouped