The jsonrpc Reference Manual

Table of Contents

The jsonrpc Reference Manual

This is the jsonrpc Reference Manual, version 0.3.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:32:46 2021 GMT+0.

1 Introduction

jsonrpc

JSON-RPC 2.0 server/client for Common Lisp.

Usage

;; server
(defvar *server* (jsonrpc:make-server))
(jsonrpc:expose *server* "sum" (lambda (args) (reduce #'+ args)))

(jsonrpc:server-listen *server* :port 50879 :mode :tcp)

;; client
(defvar *client* (jsonrpc:make-client))
(jsonrpc:client-connect *client* :url "http://127.0.0.1:50879" :mode :tcp)
(jsonrpc:call *client* "sum" '(10 20))
;=> 30

;; Calling with :timeout option
(jsonrpc:call *client* "sum" '(10 20) :timeout 1.0)
;=> 30

To invoke an interactive debugger on any errors in your handlers, set jsonrpc:*debug-on-error* to t.

Experimental features (only for Server)

• broadcast
• multicall-async

Author

• Eitaro Fukamachi (e.arrows@gmail.com)

Copyright

Copyright (c) 2016 Eitaro Fukamachi (e.arrows@gmail.com)

License

Licensed under the BSD 2-Clause License.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 jsonrpc

Author

Eitaro Fukamachi

License

BSD 2-Clause

Description

JSON-RPC 2.0 server/client implementation

Version

0.3.2

Dependency

jsonrpc/main (system)

Source

jsonrpc.asd (file)

2.2 jsonrpc/main

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies

• jsonrpc/request-response (system)
• jsonrpc/transport/interface (system)
• jsonrpc/class (system)
• jsonrpc/errors (system)

Source

jsonrpc.asd (file)

Component

file-type.lisp (file)

2.3 jsonrpc/class

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies

• jsonrpc/mapper (system)
• jsonrpc/transport/interface (system)
• jsonrpc/connection (system)
• jsonrpc/request-response (system)
• jsonrpc/errors (system)
• jsonrpc/utils (system)
• bordeaux-threads
• event-emitter
• alexandria

Source

jsonrpc.asd (file)

Component

file-type.lisp (file)

2.4 jsonrpc/mapper

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies

• jsonrpc/errors (system)
• jsonrpc/request-response (system)

Source

jsonrpc.asd (file)

Component

file-type.lisp (file)

2.5 jsonrpc/transport/interface

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies

• jsonrpc/connection (system)
• bordeaux-threads
• event-emitter
• chanl

Source

jsonrpc.asd (file)

Component

file-type.lisp (file)

2.6 jsonrpc/connection

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies

• jsonrpc/request-response (system)
• bordeaux-threads
• dissect
• event-emitter
• chanl
• vom

Source

jsonrpc.asd (file)

Component

file-type.lisp (file)

2.7 jsonrpc/request-response

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies

• jsonrpc/errors (system)
• yason
• alexandria

Source

jsonrpc.asd (file)

Component

file-type.lisp (file)

2.8 jsonrpc/utils

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies

• usocket
• bordeaux-threads

Source

jsonrpc.asd (file)

Component

file-type.lisp (file)

2.9 jsonrpc/errors

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependency

yason

Source

jsonrpc.asd (file)

Component

file-type.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 jsonrpc.asd

Location

jsonrpc.asd

Systems

• jsonrpc (system)
• jsonrpc/main (system)
• jsonrpc/class (system)
• jsonrpc/mapper (system)
• jsonrpc/transport/interface (system)
• jsonrpc/connection (system)
• jsonrpc/request-response (system)
• jsonrpc/utils (system)
• jsonrpc/errors (system)

3.1.2 jsonrpc/main/file-type.lisp

Parent

jsonrpc/main (system)

Location

main.lisp

Packages

jsonrpc

Exported Definitions

• make-client (function)
• make-server (function)

3.1.3 jsonrpc/class/file-type.lisp

Parent

jsonrpc/class (system)

Location

class.lisp

Packages

jsonrpc/class

Exported Definitions

• *default-timeout* (special variable)
• broadcast (generic function)
• broadcast (method)
• call (generic function)
• call (method)
• call-async (generic function)
• call-async (method)
• call-async (method)
• call-async-to (function)
• call-to (function)
• client (class)
• client-connect (function)
• client-connect-using-class (function)
• client-disconnect (function)
• jsonrpc-transport (method)
• (setf jsonrpc-transport) (method)
• multicall-async (generic function)
• multicall-async (method)
• notify (generic function)
• notify (method)
• notify (method)
• notify-async (generic function)
• notify-async (method)
• notify-async (method)
• notify-to (function)
• receive-message (function)
• send-message (generic function)
• send-message (method)
• server (class)
• server-listen (function)

Internal Definitions

• *call-to-error* (special variable)
• *call-to-result* (special variable)
• ensure-connected (function)
• hash-exists-p (function)
• jsonrpc (class)
• jsonrpc-params (type)
• server-client-connections (method)
• (setf server-client-connections) (method)

3.1.4 jsonrpc/mapper/file-type.lisp

Parent

jsonrpc/mapper (system)

Location

mapper.lisp

Packages

jsonrpc/mapper

Exported Definitions

• clear-methods (generic function)
• clear-methods (method)
• dispatch (generic function)
• dispatch (method)
• dispatch (method)
• exposable (class)
• expose (generic function)
• expose (method)
• register-method (generic function)
• register-method (method)

Internal Definitions

• exposable-mapper (method)
• (setf exposable-mapper) (method)

3.1.5 jsonrpc/transport/interface/file-type.lisp

Parent

jsonrpc/transport/interface (system)

Location

transport/interface.lisp

Packages

jsonrpc/transport/interface

Exported Definitions

• receive-message-using-transport (generic function)
• run-processing-loop (generic function)
• run-processing-loop (method)
• run-reading-loop (generic function)
• run-reading-loop (method)
• send-message-using-transport (generic function)
• start-client (generic function)
• start-server (generic function)
• transport (class)
• transport-connection (method)
• (setf transport-connection) (method)
• transport-message-callback (method)
• (setf transport-message-callback) (method)
• transport-threads (method)
• (setf transport-threads) (method)

3.1.6 jsonrpc/connection/file-type.lisp

Parent

jsonrpc/connection (system)

Location

connection.lisp

Packages

jsonrpc/connection

Exported Definitions

• *connection* (special variable)
• add-message-to-outbox (function)
• add-message-to-queue (generic function)
• add-message-to-queue (method)
• add-message-to-queue (method)
• add-message-to-queue (method)
• connection (class)
• connection-outbox (method)
• (setf connection-outbox) (method)
• connection-request-callback (method)
• (setf connection-request-callback) (method)
• connection-request-queue (method)
• (setf connection-request-queue) (method)
• connection-socket (method)
• (setf connection-socket) (method)
• process-request (generic function)
• process-request (method)
• process-request (method)
• wait-for-ready (generic function)
• wait-for-ready (method)

Internal Definitions

• notify-ready (generic function)
• notify-ready (method)
• process-wait (class)
• set-callback-for-id (function)

3.1.7 jsonrpc/request-response/file-type.lisp

Parent

jsonrpc/request-response (system)

Location

request-response.lisp

Packages

jsonrpc/request-response

Exported Definitions

• make-error-response (function)
• make-request (function)
• make-response (function)
• parse-message (function)
• request (structure)
• request-id (function)
• (setf request-id) (function)
• request-method (function)
• (setf request-method) (function)
• request-params (function)
• (setf request-params) (function)
• response (structure)
• response-error (function)
• (setf response-error) (function)
• response-error-code (function)
• response-error-message (function)
• response-id (function)
• (setf response-id) (function)
• response-result (function)
• (setf response-result) (function)

Internal Definitions

• copy-request (function)
• copy-response (function)
• request-p (function)
• response-p (function)
• valid-request-p (function)
• valid-response-p (function)

3.1.8 jsonrpc/utils/file-type.lisp

Parent

jsonrpc/utils (system)

Location

utils.lisp

Packages

jsonrpc/utils

Exported Definitions

• find-mode-class (function)
• make-id (function)
• random-port (function)

Internal Definitions

• *transport-load-lock* (special variable)
• port-available-p (function)

3.1.9 jsonrpc/errors/file-type.lisp

Parent

jsonrpc/errors (system)

Location

errors.lisp

Packages

jsonrpc/errors

Exported Definitions

• *debug-on-error* (special variable)
• jsonrpc-callback-error (condition)
• jsonrpc-error (condition)
• jsonrpc-error-code (method)
• (setf jsonrpc-error-code) (method)
• jsonrpc-error-message (method)
• (setf jsonrpc-error-message) (method)
• jsonrpc-internal-error (condition)
• jsonrpc-invalid-params (condition)
• jsonrpc-invalid-request (condition)
• jsonrpc-invalid-response (condition)
• jsonrpc-method-not-found (condition)
• jsonrpc-parse-error (condition)
• jsonrpc-server-error (condition)

4 Packages

Packages are listed by definition order.

4.1 jsonrpc

Source

file-type.lisp (file)

Nickname

jsonrpc/main

Use List

• jsonrpc/errors
• jsonrpc/class
• jsonrpc/transport/interface
• jsonrpc/request-response
• common-lisp

Exported Definitions

• make-client (function)
• make-server (function)

4.2 jsonrpc/class

Source

file-type.lisp (file)

Use List

common-lisp

Used By List

jsonrpc

Exported Definitions

• *default-timeout* (special variable)
• broadcast (generic function)
• broadcast (method)
• call (generic function)
• call (method)
• call-async (generic function)
• call-async (method)
• call-async (method)
• call-async-to (function)
• call-to (function)
• client (class)
• client-connect (function)
• client-connect-using-class (function)
• client-disconnect (function)
• jsonrpc-transport (generic function)
• jsonrpc-transport (method)
• (setf jsonrpc-transport) (method)
• (setf jsonrpc-transport) (generic function)
• multicall-async (generic function)
• multicall-async (method)
• notify (generic function)
• notify (method)
• notify (method)
• notify-async (generic function)
• notify-async (method)
• notify-async (method)
• notify-to (function)
• receive-message (function)
• send-message (generic function)
• send-message (method)
• server (class)
• server-listen (function)

Internal Definitions

• *call-to-error* (special variable)
• *call-to-result* (special variable)
• ensure-connected (function)
• hash-exists-p (function)
• jsonrpc (class)
• jsonrpc-params (type)
• server-client-connections (generic function)
• server-client-connections (method)
• (setf server-client-connections) (method)
• (setf server-client-connections) (generic function)

4.3 jsonrpc/mapper

Source

file-type.lisp (file)

Use List

• jsonrpc/errors
• common-lisp

Exported Definitions

• clear-methods (generic function)
• clear-methods (method)
• dispatch (generic function)
• dispatch (method)
• dispatch (method)
• exposable (class)
• expose (generic function)
• expose (method)
• register-method (generic function)
• register-method (method)

Internal Definitions

• exposable-mapper (generic function)
• exposable-mapper (method)
• (setf exposable-mapper) (method)
• (setf exposable-mapper) (generic function)

4.4 jsonrpc/transport/interface

Source

file-type.lisp (file)

Use List

common-lisp

Used By List

jsonrpc

Exported Definitions

• receive-message-using-transport (generic function)
• run-processing-loop (generic function)
• run-processing-loop (method)
• run-reading-loop (generic function)
• run-reading-loop (method)
• send-message-using-transport (generic function)
• start-client (generic function)
• start-server (generic function)
• transport (class)
• transport-connection (generic function)
• transport-connection (method)
• (setf transport-connection) (method)
• (setf transport-connection) (generic function)
• transport-message-callback (generic function)
• transport-message-callback (method)
• (setf transport-message-callback) (method)
• (setf transport-message-callback) (generic function)
• transport-threads (generic function)
• transport-threads (method)
• (setf transport-threads) (method)
• (setf transport-threads) (generic function)

4.5 jsonrpc/connection

jsonrpc/connection provides a class ‘connection’ for holding data of each connections, like inbox and outbox.

Source

file-type.lisp (file)

Use List

common-lisp

Exported Definitions

• *connection* (special variable)
• add-message-to-outbox (function)
• add-message-to-queue (generic function)
• add-message-to-queue (method)
• add-message-to-queue (method)
• add-message-to-queue (method)
• connection (class)
• connection-outbox (generic function)
• connection-outbox (method)
• (setf connection-outbox) (method)
• (setf connection-outbox) (generic function)
• connection-request-callback (generic function)
• connection-request-callback (method)
• (setf connection-request-callback) (method)
• (setf connection-request-callback) (generic function)
• connection-request-queue (generic function)
• connection-request-queue (method)
• (setf connection-request-queue) (method)
• (setf connection-request-queue) (generic function)
• connection-socket (generic function)
• connection-socket (method)
• (setf connection-socket) (method)
• (setf connection-socket) (generic function)
• process-request (generic function)
• process-request (method)
• process-request (method)
• wait-for-ready (generic function)
• wait-for-ready (method)

Internal Definitions

• notify-ready (generic function)
• notify-ready (method)
• process-wait (class)
• set-callback-for-id (function)

4.6 jsonrpc/request-response

Source

file-type.lisp (file)

Use List

• jsonrpc/errors
• common-lisp

Used By List

jsonrpc

Exported Definitions

• make-error-response (function)
• make-request (function)
• make-response (function)
• parse-message (function)
• request (structure)
• request-id (function)
• (setf request-id) (function)
• request-method (function)
• (setf request-method) (function)
• request-params (function)
• (setf request-params) (function)
• response (structure)
• response-error (function)
• (setf response-error) (function)
• response-error-code (function)
• response-error-message (function)
• response-id (function)
• (setf response-id) (function)
• response-result (function)
• (setf response-result) (function)

Internal Definitions

• copy-request (function)
• copy-response (function)
• request-p (function)
• response-p (function)
• valid-request-p (function)
• valid-response-p (function)

4.7 jsonrpc/utils

Source

file-type.lisp (file)

Use List

common-lisp

Exported Definitions

• find-mode-class (function)
• make-id (function)
• random-port (function)

Internal Definitions

• *transport-load-lock* (special variable)
• port-available-p (function)

4.8 jsonrpc/errors

Source

file-type.lisp (file)

Use List

common-lisp

Used By List

• jsonrpc
• jsonrpc/mapper
• jsonrpc/request-response

Exported Definitions

• *debug-on-error* (special variable)
• jsonrpc-callback-error (condition)
• jsonrpc-error (condition)
• jsonrpc-error-code (generic function)
• jsonrpc-error-code (method)
• (setf jsonrpc-error-code) (method)
• (setf jsonrpc-error-code) (generic function)
• jsonrpc-error-message (generic function)
• jsonrpc-error-message (method)
• (setf jsonrpc-error-message) (method)
• (setf jsonrpc-error-message) (generic function)
• jsonrpc-internal-error (condition)
• jsonrpc-invalid-params (condition)
• jsonrpc-invalid-request (condition)
• jsonrpc-invalid-response (condition)
• jsonrpc-method-not-found (condition)
• jsonrpc-parse-error (condition)
• jsonrpc-server-error (condition)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *connection*

Package

jsonrpc/connection

Source

file-type.lisp (file)

Special Variable: *debug-on-error*

Open an interactive debugger on any error.

Package

jsonrpc/errors

Source

file-type.lisp (file)

Special Variable: *default-timeout*

Package

jsonrpc/class

Source

file-type.lisp (file)

5.1.2 Functions

Function: add-message-to-outbox CONNECTION MESSAGE

Package

jsonrpc/connection

Source

file-type.lisp (file)

Function: call-async-to FROM TO METHOD &optional PARAMS CALLBACK ERROR-CALLBACK

Package

jsonrpc/class

Source

file-type.lisp (file)

Function: call-to FROM TO METHOD &optional PARAMS &rest OPTIONS

Package

jsonrpc/class

Source

file-type.lisp (file)

Function: client-connect CLIENT &rest INITARGS &key MODE &allow-other-keys

Package

jsonrpc/class

Source

file-type.lisp (file)

Function: client-connect-using-class CLIENT CLASS &rest INITARGS

Package

jsonrpc/class

Source

file-type.lisp (file)

Function: client-disconnect CLIENT

Package

jsonrpc/class

Source

file-type.lisp (file)

Function: find-mode-class MODE

Package

jsonrpc/utils

Source

file-type.lisp (file)

Function: make-client ()

Package

jsonrpc

Source

file-type.lisp (file)

Function: make-error-response &key ID CODE MESSAGE DATA

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Function: make-id &optional LENGTH

Package

jsonrpc/utils

Source

file-type.lisp (file)

Function: make-request &key (METHOD METHOD) (PARAMS PARAMS) (ID ID)

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Function: make-response &key (ERROR ERROR) (RESULT RESULT) (ID ID)

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Function: make-server ()

Package

jsonrpc

Source

file-type.lisp (file)

Function: notify-to FROM TO METHOD &optional PARAMS

Package

jsonrpc/class

Source

file-type.lisp (file)

Function: parse-message INPUT

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Function: random-port ()

Return a port number not in use from 50000 to 60000.

Package

jsonrpc/utils

Source

file-type.lisp (file)

Function: receive-message FROM CONNECTION

Package

jsonrpc/class

Source

file-type.lisp (file)

Function: request-id INSTANCE

Function: (setf request-id) VALUE INSTANCE

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Function: request-method INSTANCE

Function: (setf request-method) VALUE INSTANCE

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Function: request-params INSTANCE

Function: (setf request-params) VALUE INSTANCE

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Function: response-error INSTANCE

Function: (setf response-error) VALUE INSTANCE

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Function: response-error-code RESPONSE

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Function: response-error-message RESPONSE

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Function: response-id INSTANCE

Function: (setf response-id) VALUE INSTANCE

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Function: response-result INSTANCE

Function: (setf response-result) VALUE INSTANCE

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Function: server-listen SERVER &rest INITARGS &key MODE &allow-other-keys

Package

jsonrpc/class

Source

file-type.lisp (file)

5.1.3 Generic functions

Generic Function: add-message-to-queue CONNECTION MESSAGE

Package

jsonrpc/connection

Source

file-type.lisp (file)

Methods

Method: add-message-to-queue (CONNECTION connection) (MESSAGES list)

Method: add-message-to-queue (CONNECTION connection) (MESSAGE request)

Method: add-message-to-queue (CONNECTION connection) (MESSAGE response)

Generic Function: broadcast JSONRPC METHOD &optional PARAMS

Package

jsonrpc/class

Source

file-type.lisp (file)

Methods

Method: broadcast (SERVER server) METHOD &optional PARAMS

Generic Function: call JSONRPC METHOD &optional PARAMS &rest OPTIONS

Package

jsonrpc/class

Source

file-type.lisp (file)

Methods

Method: call (CLIENT client) METHOD &optional PARAMS &rest OPTIONS

Generic Function: call-async JSONRPC METHOD &optional PARAMS CALLBACK ERROR-CALLBACK

Package

jsonrpc/class

Source

file-type.lisp (file)

Methods

Method: call-async (CLIENT client) METHOD &optional PARAMS CALLBACK ERROR-CALLBACK

Method: call-async (SERVER server) METHOD &optional PARAMS CALLBACK ERROR-CALLBACK

Generic Function: clear-methods OBJECT

Package

jsonrpc/mapper

Source

file-type.lisp (file)

Methods

Method: clear-methods (OBJECT exposable)

Generic Function: connection-outbox OBJECT

Generic Function: (setf connection-outbox) NEW-VALUE OBJECT

Package

jsonrpc/connection

Methods

Method: connection-outbox (CONNECTION connection)

automatically generated reader method

Source

file-type.lisp (file)

Method: (setf connection-outbox) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

file-type.lisp (file)

Generic Function: connection-request-callback OBJECT

Generic Function: (setf connection-request-callback) NEW-VALUE OBJECT

Package

jsonrpc/connection

Methods

Method: connection-request-callback (CONNECTION connection)

automatically generated reader method

Source

file-type.lisp (file)

Method: (setf connection-request-callback) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

file-type.lisp (file)

Generic Function: connection-request-queue OBJECT

Generic Function: (setf connection-request-queue) NEW-VALUE OBJECT

Package

jsonrpc/connection

Methods

Method: connection-request-queue (CONNECTION connection)

automatically generated reader method

Source

file-type.lisp (file)

Method: (setf connection-request-queue) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

file-type.lisp (file)

Generic Function: connection-socket OBJECT

Generic Function: (setf connection-socket) NEW-VALUE OBJECT

Package

jsonrpc/connection

Methods

Method: connection-socket (CONNECTION connection)

automatically generated reader method

Source

file-type.lisp (file)

Method: (setf connection-socket) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

file-type.lisp (file)

Generic Function: dispatch OBJECT MESSAGE

Package

jsonrpc/mapper

Source

file-type.lisp (file)

Methods

Method: dispatch (OBJECT exposable) (REQUEST request)

Method: dispatch (OBJECT exposable) (REQUEST request) around

Generic Function: expose OBJECT METHOD-NAME FUNCTION

Package

jsonrpc/mapper

Source

file-type.lisp (file)

Methods

Method: expose (OBJECT exposable) METHOD-NAME FUNCTION

Generic Function: jsonrpc-error-code CONDITION

Generic Function: (setf jsonrpc-error-code) NEW-VALUE CONDITION

Package

jsonrpc/errors

Methods

Method: jsonrpc-error-code (CONDITION jsonrpc-error)

Method: (setf jsonrpc-error-code) NEW-VALUE (CONDITION jsonrpc-error)

Source

file-type.lisp (file)

Generic Function: jsonrpc-error-message CONDITION

Generic Function: (setf jsonrpc-error-message) NEW-VALUE CONDITION

Package

jsonrpc/errors

Methods

Method: jsonrpc-error-message (CONDITION jsonrpc-error)

Method: (setf jsonrpc-error-message) NEW-VALUE (CONDITION jsonrpc-error)

Source

file-type.lisp (file)

Generic Function: jsonrpc-transport OBJECT

Generic Function: (setf jsonrpc-transport) NEW-VALUE OBJECT

Package

jsonrpc/class

Methods

Method: jsonrpc-transport (JSONRPC jsonrpc)

automatically generated reader method

Source

file-type.lisp (file)

Method: (setf jsonrpc-transport) NEW-VALUE (JSONRPC jsonrpc)

automatically generated writer method

Source

file-type.lisp (file)

Generic Function: multicall-async JSONRPC METHOD &optional PARAMS CALLBACK ERROR-CALLBACK

Package

jsonrpc/class

Source

file-type.lisp (file)

Methods

Method: multicall-async (SERVER server) METHOD &optional PARAMS CALLBACK ERROR-CALLBACK

Generic Function: notify JSONRPC METHOD &optional PARAMS

Package

jsonrpc/class

Source

file-type.lisp (file)

Methods

Method: notify (CLIENT client) METHOD &optional PARAMS

Method: notify (SERVER server) METHOD &optional PARAMS

Generic Function: notify-async JSONRPC METHOD &optional PARAMS

Package

jsonrpc/class

Source

file-type.lisp (file)

Methods

Method: notify-async (CLIENT client) METHOD &optional PARAMS

Method: notify-async (SERVER server) METHOD &optional PARAMS

Generic Function: process-request CONNECTION REQUEST

Package

jsonrpc/connection

Source

file-type.lisp (file)

Methods

Method: process-request (CONNECTION connection) (REQUESTS list)

Method: process-request (CONNECTION connection) (REQUEST request)

Generic Function: receive-message-using-transport TRANSPORT FROM

Package

jsonrpc/transport/interface

Source

file-type.lisp (file)

Generic Function: register-method OBJECT METHOD-NAME FUNCTION

Package

jsonrpc/mapper

Source

file-type.lisp (file)

Methods

Method: register-method (OBJECT exposable) METHOD-NAME FUNCTION

Generic Function: run-processing-loop TRANSPORT CONNECTION

Package

jsonrpc/transport/interface

Source

file-type.lisp (file)

Methods

Method: run-processing-loop (TRANSPORT transport) CONNECTION

Generic Function: run-reading-loop TRANSPORT CONNECTION

Package

jsonrpc/transport/interface

Source

file-type.lisp (file)

Methods

Method: run-reading-loop (TRANSPORT transport) CONNECTION

Generic Function: send-message TO CONNECTION MESSAGE

Package

jsonrpc/class

Source

file-type.lisp (file)

Methods

Method: send-message TO CONNECTION MESSAGE

Generic Function: send-message-using-transport TRANSPORT TO MESSAGE

Package

jsonrpc/transport/interface

Source

file-type.lisp (file)

Generic Function: start-client TRANSPORT

Package

jsonrpc/transport/interface

Source

file-type.lisp (file)

Generic Function: start-server TRANSPORT

Package

jsonrpc/transport/interface

Source

file-type.lisp (file)

Generic Function: transport-connection OBJECT

Generic Function: (setf transport-connection) NEW-VALUE OBJECT

Package

jsonrpc/transport/interface

Methods

Method: transport-connection (TRANSPORT transport)

automatically generated reader method

Source

file-type.lisp (file)

Method: (setf transport-connection) NEW-VALUE (TRANSPORT transport)

automatically generated writer method

Source

file-type.lisp (file)

Generic Function: transport-message-callback OBJECT

Generic Function: (setf transport-message-callback) NEW-VALUE OBJECT

Package

jsonrpc/transport/interface

Methods

Method: transport-message-callback (TRANSPORT transport)

automatically generated reader method

Source

file-type.lisp (file)

Method: (setf transport-message-callback) NEW-VALUE (TRANSPORT transport)

automatically generated writer method

Source

file-type.lisp (file)

Generic Function: transport-threads OBJECT

Generic Function: (setf transport-threads) NEW-VALUE OBJECT

Package

jsonrpc/transport/interface

Methods

Method: transport-threads (TRANSPORT transport)

automatically generated reader method

Source

file-type.lisp (file)

Method: (setf transport-threads) NEW-VALUE (TRANSPORT transport)

automatically generated writer method

Source

file-type.lisp (file)

Generic Function: wait-for-ready PROCESS-WAIT

Package

jsonrpc/connection

Source

file-type.lisp (file)

Methods

Method: wait-for-ready (PROCESS-WAIT process-wait)

5.1.4 Conditions

Condition: jsonrpc-callback-error ()

Package

jsonrpc/errors

Source

file-type.lisp (file)

Direct superclasses

jsonrpc-error (condition)

Condition: jsonrpc-error ()

Package

jsonrpc/errors

Source

file-type.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• jsonrpc-parse-error (condition)
• jsonrpc-invalid-request (condition)
• jsonrpc-invalid-response (condition)
• jsonrpc-method-not-found (condition)
• jsonrpc-invalid-params (condition)
• jsonrpc-internal-error (condition)
• jsonrpc-server-error (condition)
• jsonrpc-callback-error (condition)

Direct methods

• encode (method)
• jsonrpc-error-message (method)
• jsonrpc-error-message (method)
• jsonrpc-error-code (method)
• jsonrpc-error-code (method)

Direct slots

Slot: code

Initargs

:code

Initform

(quote -1)

Readers

jsonrpc-error-code (generic function)

Writers

(setf jsonrpc-error-code) (generic function)

Slot: message

Initargs

:message

Initform

(quote "")

Readers

jsonrpc-error-message (generic function)

Writers

(setf jsonrpc-error-message) (generic function)

Condition: jsonrpc-internal-error ()

Package

jsonrpc/errors

Source

file-type.lisp (file)

Direct superclasses

jsonrpc-error (condition)

Direct slots

Slot: code

Initargs

:code

Initform

(quote -32603)

Slot: message

Initargs

:message

Initform

(quote "internal error")

Condition: jsonrpc-invalid-params ()

Package

jsonrpc/errors

Source

file-type.lisp (file)

Direct superclasses

jsonrpc-error (condition)

Direct slots

Slot: code

Initargs

:code

Initform

(quote -32602)

Slot: message

Initargs

:message

Initform

(quote "invalid params")

Condition: jsonrpc-invalid-request ()

Package

jsonrpc/errors

Source

file-type.lisp (file)

Direct superclasses

jsonrpc-error (condition)

Direct slots

Slot: code

Initargs

:code

Initform

(quote -32600)

Slot: message

Initargs

:message

Initform

(quote "invalid request")

Condition: jsonrpc-invalid-response ()

Package

jsonrpc/errors

Source

file-type.lisp (file)

Direct superclasses

jsonrpc-error (condition)

Direct slots

Slot: code

Initargs

:code

Initform

(quote -32000)

Slot: message

Initargs

:message

Initform

(quote "invalid response")

Condition: jsonrpc-method-not-found ()

Package

jsonrpc/errors

Source

file-type.lisp (file)

Direct superclasses

jsonrpc-error (condition)

Direct slots

Slot: code

Initargs

:code

Initform

(quote -32601)

Slot: message

Initargs

:message

Initform

(quote "method not found")

Condition: jsonrpc-parse-error ()

Package

jsonrpc/errors

Source

file-type.lisp (file)

Direct superclasses

jsonrpc-error (condition)

Direct slots

Slot: code

Initargs

:code

Initform

(quote -32700)

Slot: message

Initargs

:message

Initform

(quote "parse error")

Condition: jsonrpc-server-error ()

Package

jsonrpc/errors

Source

file-type.lisp (file)

Direct superclasses

jsonrpc-error (condition)

5.1.5 Structures

Structure: request ()

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

• dispatch (method)
• dispatch (method)
• process-request (method)
• add-message-to-queue (method)
• encode (method)

Direct slots

Slot: method

Readers

request-method (function)

Writers

(setf request-method) (function)

Slot: params

Readers

request-params (function)

Writers

(setf request-params) (function)

Slot: id

Readers

request-id (function)

Writers

(setf request-id) (function)

Structure: response ()

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

• add-message-to-queue (method)
• encode (method)

Direct slots

Slot: error

Readers

response-error (function)

Writers

(setf response-error) (function)

Slot: result

Readers

response-result (function)

Writers

(setf response-result) (function)

Slot: id

Readers

response-id (function)

Writers

(setf response-id) (function)

5.1.6 Classes

Class: client ()

Package

jsonrpc/class

Source

file-type.lisp (file)

Direct superclasses

jsonrpc (class)

Direct methods

• notify-async (method)
• notify (method)
• call-async (method)
• call (method)

Class: connection ()

Package

jsonrpc/connection

Source

file-type.lisp (file)

Direct superclasses

• process-wait (class)
• event-emitter (class)

Direct methods

• process-request (method)
• process-request (method)
• add-message-to-queue (method)
• add-message-to-queue (method)
• add-message-to-queue (method)
• connection-outbox (method)
• connection-outbox (method)
• connection-request-queue (method)
• connection-request-queue (method)
• connection-request-callback (method)
• connection-request-callback (method)
• connection-socket (method)
• connection-socket (method)

Direct slots

Slot: socket

Initargs

:socket

Readers

connection-socket (generic function)

Writers

(setf connection-socket) (generic function)

Slot: request-callback

Initargs

:request-callback

Readers

connection-request-callback (generic function)

Writers

(setf connection-request-callback) (generic function)

Slot: request-queue

Initform

(make-instance (quote chanl:unbounded-channel))

Readers

connection-request-queue (generic function)

Writers

(setf connection-request-queue) (generic function)

Slot: response-map

Initform

(make-hash-table :test (quote equal))

Slot: response-lock

Initform

(bordeaux-threads:make-recursive-lock "jsonrpc/connection response-lock")

Slot: response-callback

Initform

(make-hash-table :test (quote equal))

Slot: outbox

Initform

(make-instance (quote chanl:unbounded-channel))

Readers

connection-outbox (generic function)

Writers

(setf connection-outbox) (generic function)

Class: exposable ()

Package

jsonrpc/mapper

Source

file-type.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

jsonrpc (class)

Direct methods

• dispatch (method)
• dispatch (method)
• clear-methods (method)
• expose (method)
• exposable-mapper (method)
• exposable-mapper (method)

Direct slots

Slot: mapper

Initform

(make-hash-table :test (quote equal))

Readers

exposable-mapper (generic function)

Writers

(setf exposable-mapper) (generic function)

Class: server ()

Package

jsonrpc/class

Source

file-type.lisp (file)

Direct superclasses

jsonrpc (class)

Direct methods

• multicall-async (method)
• broadcast (method)
• notify-async (method)
• notify (method)
• call-async (method)
• server-client-connections (method)
• server-client-connections (method)

Direct slots

Slot: client-connections

Initform

(quote nil)

Readers

server-client-connections (generic function)

Writers

(setf server-client-connections) (generic function)

Slot: %lock

Initform

(bordeaux-threads:make-lock "client-connections-lock")

Class: transport ()

Package

jsonrpc/transport/interface

Source

file-type.lisp (file)

Direct superclasses

event-emitter (class)

Direct methods

• run-reading-loop (method)
• run-processing-loop (method)
• transport-threads (method)
• transport-threads (method)
• transport-connection (method)
• transport-connection (method)
• transport-message-callback (method)
• transport-message-callback (method)

Direct slots

Slot: message-callback

Initargs

:message-callback

Readers

transport-message-callback (generic function)

Writers

(setf transport-message-callback) (generic function)

Slot: connection

Readers

transport-connection (generic function)

Writers

(setf transport-connection) (generic function)

Slot: threads

Initform

(quote nil)

Readers

transport-threads (generic function)

Writers

(setf transport-threads) (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *call-to-error*

Package

jsonrpc/class

Source

file-type.lisp (file)

Special Variable: *call-to-result*

Package

jsonrpc/class

Source

file-type.lisp (file)

Special Variable: *transport-load-lock*

Package

jsonrpc/utils

Source

file-type.lisp (file)

5.2.2 Functions

Function: copy-request INSTANCE

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Function: copy-response INSTANCE

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Function: ensure-connected JSONRPC

Package

jsonrpc/class

Source

file-type.lisp (file)

Function: hash-exists-p HASH-TABLE KEY

Package

jsonrpc/class

Source

file-type.lisp (file)

Function: port-available-p PORT

Package

jsonrpc/utils

Source

file-type.lisp (file)

Function: request-p OBJECT

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Function: response-p OBJECT

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Function: set-callback-for-id CONNECTION ID CALLBACK

Package

jsonrpc/connection

Source

file-type.lisp (file)

Function: valid-request-p REQUEST

Package

jsonrpc/request-response

Source

file-type.lisp (file)

Function: valid-response-p RESPONSE

Package

jsonrpc/request-response

Source

file-type.lisp (file)

5.2.3 Generic functions

Generic Function: exposable-mapper OBJECT

Generic Function: (setf exposable-mapper) NEW-VALUE OBJECT

Package

jsonrpc/mapper

Methods

Method: exposable-mapper (EXPOSABLE exposable)

automatically generated reader method

Source

file-type.lisp (file)

Method: (setf exposable-mapper) NEW-VALUE (EXPOSABLE exposable)

automatically generated writer method

Source

file-type.lisp (file)

Generic Function: notify-ready PROCESS-WAIT

Package

jsonrpc/connection

Source

file-type.lisp (file)

Methods

Method: notify-ready (PROCESS-WAIT process-wait)

Generic Function: server-client-connections OBJECT

Generic Function: (setf server-client-connections) NEW-VALUE OBJECT

Package

jsonrpc/class

Methods

Method: server-client-connections (SERVER server)

automatically generated reader method

Source

file-type.lisp (file)

Method: (setf server-client-connections) NEW-VALUE (SERVER server)

automatically generated writer method

Source

file-type.lisp (file)

5.2.4 Classes

Class: jsonrpc ()

Package

jsonrpc/class

Source

file-type.lisp (file)

Direct superclasses

• exposable (class)
• event-emitter (class)

Direct subclasses

• client (class)
• server (class)

Direct methods

• jsonrpc-transport (method)
• jsonrpc-transport (method)

Direct slots

Slot: transport

Type

(or null jsonrpc/transport/interface:transport)

Initargs

:transport

Readers

jsonrpc-transport (generic function)

Writers

(setf jsonrpc-transport) (generic function)

Class: process-wait ()

Package

jsonrpc/connection

Source

file-type.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

connection (class)

Direct methods

• notify-ready (method)
• wait-for-ready (method)

Direct slots

Slot: condvar

Initform

(bordeaux-threads:make-condition-variable)

Slot: condlock

Initform

(bordeaux-threads:make-recursive-lock)

5.2.5 Types

Type: jsonrpc-params ()

Package

jsonrpc/class

Source

file-type.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions