chickadee » json-rpc

json-rpc

Description

An implementation of the JSON-RPC for Scheme.

The JSON-RPC allows calling procedures on remote servers by exchanging JSON objects. It's specification can be found at [https://www.jsonrpc.org/specification|https://www.jsonrpc.org/specification].

Author

Ricardo G. Herdt

Repository

https://gitlab.com/rgherdt/scheme-json-rpc.git

Requirements

Documentation

High-level API

json-rpc-handler-tableparameter

An association list mapping method names ({{string}s}) to functions that get an (unmarshalled) scheme object as input. These handlers must return one of the following: - a scheme object that is 'mappable' to a JSON string, which becomes the {result} content of the response. See medea for the mapping between JSON and Scheme objects. - #f, if no response is expected. This is the way to handle notifications.

json-rpc-call in-port out-port method paramsprocedure
json-rpc-call/tcp tcp-address tcp-port method paramsprocedure

Call the remote procedure method (string) with the JSON-mappable scheme object params. See medea.

json-rpc-start-server/tcp tcp-portprocedure

Listen on tcp-port and loop over input connections, answering requests according to json-rpc-handler-table.

Low-level API

json-rpc-read input-portprocedure

Read from input-port and return a Scheme object based on the provided json-string->scheme parameter.

json-rpc-write scm output-portprocedure

Convert the scheme object scm to a JSON string using the provided paramter scheme->json-string and writes the result to output-port.

json-rpc-loop input-port output-portprocedure

JSON-RPC 2.0 demands that all requests are answered. This functions loops over input-port and answers to the requests through output-port using the handlers defined in json-rpc-handler-table.

Error handling

User-created errors are meant to be raised by handlers defined in {json-rpc-handler-table}, and are properly delivered to the calling process according to the JSON-RPC protocol.

custom-error-codesparameter

JSON-RPC supports custom server-side error codes. This parameter defines an alist mapping custom error names ({symbol}s) to error codes ({integer}) ranging between -32000 and -32099.

make-json-rpc-custom-error error-symbol #!optional msgprocedure

Create an error instance of {error-symbol} ({symbol}) with an optional {msg} ({string}). It's an error if {error-type} isn't defined in {custom-error-codes}.

make-json-rpc-internal-errorprocedure

Create a generic error object.

json-rpc-error? conditionprocedure
json-rpc-custom-error? conditionprocedure
json-rpc-internal-error? conditionprocedure

Predicates for several error objects.

Examples

 ;; server.scm
 (import (json-rpc))
 (parameterize
   ((json-rpc-handler-table
      `(("hello" . ,(lambda (params)
                      (let ((name (cdr (assoc 'name params))))
                        (string-append "Hello " name))))
        ("exit" . ,(lambda (params)
                     (json-rpc-exit)
                     #f)))))
  (json-rpc-start-server/tcp 4242))
 ;; client.scm
 (import (json-rpc))
 (json-rpc-call/tcp "localhost" 4242 "hello" '((name . "World!")))

License

MIT License

Copyright (c) 2021 Ricardo G. Herdt

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version History

Contents »