Class

com.avsystem.commons.rpc

methodTag

Related Doc: package rpc

Permalink

final class methodTag[BaseTag <: RpcTag] extends Annotation with RawRpcAnnotation

Method tagging lets you have more explicit control over which raw methods can match which real methods. Example:

sealed trait MethodType extends RpcTag
class GET extends RestMethod
class POST extends RestMethod

@methodTag[MethodType](new GET)
trait ExampleRawRpc {
  @tagged[GET] def get(@methodName name: String, @multi args: Map[String,Json]): Future[Json]
  @tagged[POST] def post(@methodName name: String, @multi args: Map[String,Json]): Future[Json]
}

In the example above, we created a hierarchy of annotations rooted at MethodType which can be used on real methods in order to explicitly tell the RPC macro which raw methods can match it. We also specify new GET as the default tag that will be assumed for real methods without any tag annotation. Then, using tagged we specify that the raw get method may only match real methods annotated as GET while post raw method may only match real methods annotated as POST. Raw methods not annotated with tagged have no limitations and may still match any real methods.

Also, instead of specifying defaultTag in @methodTag annotation, you may provide the whenUntagged parameter to tagged annotation. Raw method annotated as @tagged[MethodType](whenUntagged = new GET) will match real methods either explicitly tagged with GET or untagged. If untagged, new GET will be assumed as the tag. This is useful when you want to have multiple raw methods with different whenUntagged setting.

NOTE: The example above assumes there is a Json type defined with appropriate encodings - see encoded for more details on parameter and method result encoding.

An example of real RPC for ExampleRawRpc:

trait ExampleApi {
  def getUser(id: UserId): Future[User]
  @POST def saveUser(user: User): Future[Unit]
}
object ExampleApi {
  implicit val AsRawReal: AsRawReal[ExampleRawRpc,ExampleApi] = AsRawReal.materialize
}
BaseTag

base type for tags that can be used on real RPC methods

Linear Supertypes
RawRpcAnnotation, RawSymAnnotation, StaticAnnotation, Annotation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. methodTag
  2. RawRpcAnnotation
  3. RawSymAnnotation
  4. StaticAnnotation
  5. Annotation
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new methodTag(defaultTag: BaseTag = null)

    Permalink

    defaultTag

    default tag value assumed for untagged methods

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. val defaultTag: BaseTag

    Permalink

    default tag value assumed for untagged methods

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def wait(): Unit

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

  19. final def wait(arg0: Long, arg1: Int): Unit

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

  20. final def wait(arg0: Long): Unit

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

Inherited from RawRpcAnnotation

Inherited from RawSymAnnotation

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Ungrouped