Consts
INTERNAL_ERROR = -32603
- Source Edit
INVALID_PARAMS = -32602
- Source Edit
INVALID_REQUEST = -32600
- Source Edit
JSON_ENCODE_ERROR = -32001
- Source Edit
JSON_PARSE_ERROR = -32700
- Source Edit
METHOD_NOT_FOUND = -32601
- Source Edit
SERVER_ERROR = -32000
- Source Edit
Procs
proc route(router: RpcRouter; data: string | seq[byte]): InternalRaisesFuture[ string, void] {....stackTrace: false, raises: [], gcsafe, raises: [], gcsafe.}
-
Route to RPC from string data.
data must be a valid JSON-RPC request or batch request.
Returns the JSON-encoded response.
Source Edit proc route(router: RpcRouter; req: RequestRx2): InternalRaisesFuture[ResponseTx, void] {....stackTrace: false, raises: [], gcsafe, raises: [], gcsafe, tags: [RootEffect], forbids: [].}
- Source Edit
proc route(router: RpcRouter; request: RequestBatchRx): InternalRaisesFuture[ seq[byte], void] {....stackTrace: false, raises: [], gcsafe, raises: [], gcsafe, tags: [RootEffect], forbids: [].}
- Routes the request(s) requests and encodes the responses encoded as JSON Source Edit
Macros
macro rpc(server: RpcRouter; path: static[string]; formatType, body: untyped): untyped {..}
-
Define a remote procedure call. Input and return parameters are defined using the do notation. For example:
myServer.rpc("path") do(param1: int, param2: float) -> string: result = $param1 & " " & $param2
Input parameters are automatically marshalled from json to Nim types, and output parameters are automatically marshalled to json for transport.
Source Edit
Exports
-
flavorEnumRep, automaticPrimitivesSerialization, Reader, decode, flavorUsesAutomaticObjectSerialization, flavorEnumRep, typeAutoSerialize, typeClassOrMemberAutoSerialize, flavorRequiresAllFields, Writer, mimeType, flavorOmitsOptionalFields, automaticSerialization, automaticBuiltinSerialization, flavorSkipNullFields, flavorAllowsUnknownFields, PreferredOutputType, JrpcConv, decode, flavorEnumRep, automaticPrimitivesSerialization, $, Reader, ==, readValue, writeValue, RequestTx, writeValue, ResponseError, flavorEnumRep, typeAutoSerialize, ParamDescNamed, readValue, RequestRx, RequestId, toTx, readValue, readValue, RequestRx2, readValue, readValue, ReBatchKind, JsonRPC2, flavorRequiresAllFields, RequestParamKind, writeValue, hash, RequestParamsTx, writeValue, Writer, mimeType, flavorOmitsOptionalFields, ResponseRx, readValue, ResponseRx2, flavorUsesAutomaticObjectSerialization, writeValue, writeValue, automaticBuiltinSerialization, readValue, ResponseTx, RequestParamsRx, writeValue, ResponseKind, flavorSkipNullFields, ReqRespHeader, readValue, writeRequest, typeClassOrMemberAutoSerialize, flavorAllowsUnknownFields, writeNotification, shouldWriteObjectField, ParamDescRx, readValue, PreferredOutputType, withWriter, RequestBatchRx, automaticSerialization, readValue, isFieldExpected, meth, RequestIdKind, JrpcSys