Method tagging lets you have more explicit control over which raw methods can match which real methods.
Example:
sealedtrait RestMethod extends RpcTag
class GET extends RestMethod
class POST extends RestMethod
@methodTag[RestMethod,GET]
trait RestRawRpc {
@tagged[GET] def get(name: String, @multi args: Map[String,Json]): Future[Json]
@tagged[POST] def post(name: String, @multi args: Map[String,Json]): Future[Json]
}
In the example above, we created a hierarchy of annotations rooted at RestMethod which can be used
on real methods in order to explicitly tell the RPC macro which raw methods can match it.
We also specify 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.
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.
base type for tags that can be used on real RPC methods
DefaultTag
the default tag type used for real methods not explicitly tagged - if you don't want to
introduce any specific default tag, just use the same type as for BaseTag
Method tagging lets you have more explicit control over which raw methods can match which real methods. Example:
In the example above, we created a hierarchy of annotations rooted at
RestMethod
which can be used on real methods in order to explicitly tell the RPC macro which raw methods can match it. We also specifyGET
as the default tag that will be assumed for real methods without any tag annotation. Then, using@tagged
we specify that the rawget
method may only match real methods annotated asGET
whilepost
raw method may only match real methods annotated asPOST
. Raw methods not annotated with@tagged
have no limitations and may still match any real methods.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
RestRawRpc
:base type for tags that can be used on real RPC methods
the default tag type used for real methods not explicitly tagged - if you don't want to introduce any specific default tag, just use the same type as for
BaseTag