The jsonrpc Reference Manual

This is the jsonrpc Reference Manual, version 0.3.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:49:33 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 jsonrpc

JSON-RPC 2.0 server/client implementation

Author

Eitaro Fukamachi

License

BSD 2-Clause

Version

0.3.2

Dependency

jsonrpc/main (system).

Source

jsonrpc.asd.


2.2 jsonrpc/main

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies
Source

jsonrpc.asd.


2.3 jsonrpc/request-response

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies
Source

jsonrpc.asd.


2.4 jsonrpc/errors

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependency

yason (system).

Source

jsonrpc.asd.


2.5 jsonrpc/transport/interface

Author

Eitaro Fukamachi

License

BSD 2-Clause

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

jsonrpc.asd.


2.6 jsonrpc/connection

Author

Eitaro Fukamachi

License

BSD 2-Clause

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

jsonrpc.asd.


2.7 jsonrpc/class

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies
Source

jsonrpc.asd.


2.8 jsonrpc/mapper

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies
Source

jsonrpc.asd.


2.9 jsonrpc/utils

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies
  • usocket (system).
  • bordeaux-threads (system).
Source

jsonrpc.asd.


3 Files

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


3.1 Lisp


3.1.2 jsonrpc/main/file-type.lisp

Source

jsonrpc.asd.

Parent Component

jsonrpc/main (system).

Packages

jsonrpc.

Public Interface

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

Source

jsonrpc.asd.

Parent Component

jsonrpc/request-response (system).

Packages

jsonrpc/request-response.

Public Interface
Internals

3.1.4 jsonrpc/errors/file-type.lisp

Source

jsonrpc.asd.

Parent Component

jsonrpc/errors (system).

Packages

jsonrpc/errors.

Public Interface

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

Source

jsonrpc.asd.

Parent Component

jsonrpc/transport/interface (system).

Packages

jsonrpc/transport/interface.

Public Interface

3.1.6 jsonrpc/connection/file-type.lisp

Source

jsonrpc.asd.

Parent Component

jsonrpc/connection (system).

Packages

jsonrpc/connection.

Public Interface
Internals

3.1.7 jsonrpc/class/file-type.lisp

Source

jsonrpc.asd.

Parent Component

jsonrpc/class (system).

Packages

jsonrpc/class.

Public Interface
Internals

3.1.8 jsonrpc/mapper/file-type.lisp

Source

jsonrpc.asd.

Parent Component

jsonrpc/mapper (system).

Packages

jsonrpc/mapper.

Public Interface
Internals

3.1.9 jsonrpc/utils/file-type.lisp

Source

jsonrpc.asd.

Parent Component

jsonrpc/utils (system).

Packages

jsonrpc/utils.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 jsonrpc/mapper

Source

file-type.lisp.

Use List
Public Interface
Internals

4.2 jsonrpc/connection

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

Source

file-type.lisp.

Use List

common-lisp.

Public Interface
Internals

4.3 jsonrpc/errors

Source

file-type.lisp.

Use List

common-lisp.

Used By List
Public Interface

4.4 jsonrpc/class

Source

file-type.lisp.

Use List

common-lisp.

Used By List

jsonrpc.

Public Interface
Internals

4.5 jsonrpc/transport/interface

Source

file-type.lisp.

Use List

common-lisp.

Used By List

jsonrpc.

Public Interface

4.6 jsonrpc/request-response

Source

file-type.lisp.

Use List
Used By List

jsonrpc.

Public Interface
Internals

4.7 jsonrpc

Source

file-type.lisp.

Nickname

jsonrpc/main

Use List
Public Interface

4.8 jsonrpc/utils

Source

file-type.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *connection*
Package

jsonrpc/connection.

Source

file-type.lisp.

Special Variable: *debug-on-error*

Open an interactive debugger on any error.

Package

jsonrpc/errors.

Source

file-type.lisp.

Special Variable: *default-timeout*
Package

jsonrpc/class.

Source

file-type.lisp.


5.1.2 Ordinary functions

Function: add-message-to-outbox (connection message)
Package

jsonrpc/connection.

Source

file-type.lisp.

Function: bind-server-to-transport (server transport)

Initializes all necessary event handlers inside TRANSPORT to process calls to the SERVER.

This function can be usefule if you want to create server and transport instance manually, and then to start transport as part of a bigger server.

Package

jsonrpc/class.

Source

file-type.lisp.

Function: call-async-to (from to method &optional params callback error-callback)
Package

jsonrpc/class.

Source

file-type.lisp.

Function: client-connect (client &rest initargs &key mode &allow-other-keys)
Package

jsonrpc/class.

Source

file-type.lisp.

Function: client-connect-using-class (client class &rest initargs)
Package

jsonrpc/class.

Source

file-type.lisp.

Function: client-disconnect (client)
Package

jsonrpc/class.

Source

file-type.lisp.

Function: find-mode-class (mode)
Package

jsonrpc/utils.

Source

file-type.lisp.

Function: make-client ()
Package

jsonrpc.

Source

file-type.lisp.

Function: make-error-response (&key id code message data)
Package

jsonrpc/request-response.

Source

file-type.lisp.

Function: make-id (&optional length)
Package

jsonrpc/utils.

Source

file-type.lisp.

Function: make-request (&key method params id)
Package

jsonrpc/request-response.

Source

file-type.lisp.

Function: make-response (&key error result id)
Package

jsonrpc/request-response.

Source

file-type.lisp.

Function: make-server ()
Package

jsonrpc.

Source

file-type.lisp.

Function: notify-to (from to method &optional params)
Package

jsonrpc/class.

Source

file-type.lisp.

Function: parse-message (input)
Package

jsonrpc/request-response.

Source

file-type.lisp.

Function: random-port ()

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

Package

jsonrpc/utils.

Source

file-type.lisp.

Function: receive-message (from connection)
Package

jsonrpc/class.

Source

file-type.lisp.

Reader: request-id (instance)
Writer: (setf request-id) (instance)
Package

jsonrpc/request-response.

Source

file-type.lisp.

Target Slot

id.

Reader: request-method (instance)
Writer: (setf request-method) (instance)
Package

jsonrpc/request-response.

Source

file-type.lisp.

Target Slot

method.

Reader: request-params (instance)
Writer: (setf request-params) (instance)
Package

jsonrpc/request-response.

Source

file-type.lisp.

Target Slot

params.

Reader: response-error (instance)
Writer: (setf response-error) (instance)
Package

jsonrpc/request-response.

Source

file-type.lisp.

Target Slot

error.

Function: response-error-code (response)
Package

jsonrpc/request-response.

Source

file-type.lisp.

Function: response-error-message (response)
Package

jsonrpc/request-response.

Source

file-type.lisp.

Reader: response-id (instance)
Writer: (setf response-id) (instance)
Package

jsonrpc/request-response.

Source

file-type.lisp.

Target Slot

id.

Reader: response-result (instance)
Writer: (setf response-result) (instance)
Package

jsonrpc/request-response.

Source

file-type.lisp.

Target Slot

result.

Function: server-listen (server &rest initargs &key mode &allow-other-keys)
Package

jsonrpc/class.

Source

file-type.lisp.


5.1.3 Generic functions

Generic Function: add-message-to-queue (connection message)
Package

jsonrpc/connection.

Source

file-type.lisp.

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.

Methods
Method: broadcast ((server server) method &optional params)
Generic Function: call (jsonrpc method &optional params &rest options)
Package

jsonrpc/class.

Source

file-type.lisp.

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.

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: call-to (from-client to-connection method &optional params &rest options)

Makes a synchronouse RPC call. Should return an instance of JSONRPC/REQUEST-RESPONSE:RESPONSE class.

Package

jsonrpc/class.

Source

file-type.lisp.

Methods
Method: call-to ((from jsonrpc) (to connection) (method string) &optional params &rest options)
Generic Function: clear-methods (object)
Package

jsonrpc/mapper.

Source

file-type.lisp.

Methods
Method: clear-methods ((object exposable))
Generic Reader: connection-outbox (object)
Package

jsonrpc/connection.

Methods
Reader Method: connection-outbox ((connection connection))

automatically generated reader method

Source

file-type.lisp.

Target Slot

outbox.

Generic Writer: (setf connection-outbox) (object)
Package

jsonrpc/connection.

Methods
Writer Method: (setf connection-outbox) ((connection connection))

automatically generated writer method

Source

file-type.lisp.

Target Slot

outbox.

Generic Reader: connection-request-callback (object)
Package

jsonrpc/connection.

Methods
Reader Method: connection-request-callback ((connection connection))

automatically generated reader method

Source

file-type.lisp.

Target Slot

request-callback.

Generic Writer: (setf connection-request-callback) (object)
Package

jsonrpc/connection.

Methods
Writer Method: (setf connection-request-callback) ((connection connection))

automatically generated writer method

Source

file-type.lisp.

Target Slot

request-callback.

Generic Reader: connection-request-queue (object)
Package

jsonrpc/connection.

Methods
Reader Method: connection-request-queue ((connection connection))

automatically generated reader method

Source

file-type.lisp.

Target Slot

request-queue.

Generic Writer: (setf connection-request-queue) (object)
Package

jsonrpc/connection.

Methods
Writer Method: (setf connection-request-queue) ((connection connection))

automatically generated writer method

Source

file-type.lisp.

Target Slot

request-queue.

Generic Reader: connection-socket (object)
Package

jsonrpc/connection.

Methods
Reader Method: connection-socket ((connection connection))

automatically generated reader method

Source

file-type.lisp.

Target Slot

socket.

Generic Writer: (setf connection-socket) (object)
Package

jsonrpc/connection.

Methods
Writer Method: (setf connection-socket) ((connection connection))

automatically generated writer method

Source

file-type.lisp.

Target Slot

socket.

Generic Function: dispatch (object message)
Package

jsonrpc/mapper.

Source

file-type.lisp.

Methods
Method: dispatch ((object exposable) (request request))
Method: dispatch :around ((object exposable) (request request))
Generic Function: expose (object method-name function)
Package

jsonrpc/mapper.

Source

file-type.lisp.

Methods
Method: expose ((object exposable) method-name function)
Generic Reader: jsonrpc-error-code (condition)
Generic Writer: (setf jsonrpc-error-code) (condition)
Package

jsonrpc/errors.

Methods
Reader Method: jsonrpc-error-code ((condition jsonrpc-error))
Writer Method: (setf jsonrpc-error-code) ((condition jsonrpc-error))
Source

file-type.lisp.

Target Slot

code.

Generic Reader: jsonrpc-error-message (condition)
Generic Writer: (setf jsonrpc-error-message) (condition)
Package

jsonrpc/errors.

Methods
Reader Method: jsonrpc-error-message ((condition jsonrpc-error))
Writer Method: (setf jsonrpc-error-message) ((condition jsonrpc-error))
Source

file-type.lisp.

Target Slot

message.

Generic Reader: jsonrpc-transport (object)
Package

jsonrpc/class.

Methods
Reader Method: jsonrpc-transport ((jsonrpc jsonrpc))

automatically generated reader method

Source

file-type.lisp.

Target Slot

transport.

Generic Writer: (setf jsonrpc-transport) (object)
Package

jsonrpc/class.

Methods
Writer Method: (setf jsonrpc-transport) ((jsonrpc jsonrpc))

automatically generated writer method

Source

file-type.lisp.

Target Slot

transport.

Generic Function: multicall-async (jsonrpc method &optional params callback error-callback)
Package

jsonrpc/class.

Source

file-type.lisp.

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.

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.

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.

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.

Generic Function: register-method (object method-name function)
Package

jsonrpc/mapper.

Alias for

expose.

Generic Function: run-processing-loop (transport connection)
Package

jsonrpc/transport/interface.

Source

file-type.lisp.

Methods
Method: run-processing-loop ((transport transport) connection)
Generic Function: run-reading-loop (transport connection)
Package

jsonrpc/transport/interface.

Source

file-type.lisp.

Methods
Method: run-reading-loop ((transport transport) connection)
Generic Function: send-message (to connection message)
Package

jsonrpc/class.

Source

file-type.lisp.

Methods
Method: send-message (to connection message)
Generic Function: send-message-using-transport (transport to message)
Package

jsonrpc/transport/interface.

Source

file-type.lisp.

Generic Function: start-client (transport)
Package

jsonrpc/transport/interface.

Source

file-type.lisp.

Generic Function: start-server (transport)
Package

jsonrpc/transport/interface.

Source

file-type.lisp.

Generic Reader: transport-connection (object)
Package

jsonrpc/transport/interface.

Methods
Reader Method: transport-connection ((transport transport))

automatically generated reader method

Source

file-type.lisp.

Target Slot

connection.

Generic Writer: (setf transport-connection) (object)
Package

jsonrpc/transport/interface.

Methods
Writer Method: (setf transport-connection) ((transport transport))

automatically generated writer method

Source

file-type.lisp.

Target Slot

connection.

Generic Reader: transport-message-callback (object)
Package

jsonrpc/transport/interface.

Methods
Reader Method: transport-message-callback ((transport transport))

automatically generated reader method

Source

file-type.lisp.

Target Slot

message-callback.

Generic Writer: (setf transport-message-callback) (object)
Package

jsonrpc/transport/interface.

Methods
Writer Method: (setf transport-message-callback) ((transport transport))

automatically generated writer method

Source

file-type.lisp.

Target Slot

message-callback.

Generic Reader: transport-threads (object)
Package

jsonrpc/transport/interface.

Methods
Reader Method: transport-threads ((transport transport))

automatically generated reader method

Source

file-type.lisp.

Target Slot

threads.

Generic Writer: (setf transport-threads) (object)
Package

jsonrpc/transport/interface.

Methods
Writer Method: (setf transport-threads) ((transport transport))

automatically generated writer method

Source

file-type.lisp.

Target Slot

threads.

Generic Function: wait-for-ready (process-wait)
Package

jsonrpc/connection.

Source

file-type.lisp.

Methods
Method: wait-for-ready ((process-wait process-wait))

5.1.4 Standalone methods

Method: encode ((object jsonrpc-error) &optional stream)
Package

yason.

Source

file-type.lisp.

Method: encode ((response response) &optional stream)
Package

yason.

Source

file-type.lisp.

Method: encode ((request request) &optional stream)
Package

yason.

Source

file-type.lisp.


5.1.5 Conditions

Condition: jsonrpc-callback-error
Package

jsonrpc/errors.

Source

file-type.lisp.

Direct superclasses

jsonrpc-error.

Condition: jsonrpc-error
Package

jsonrpc/errors.

Source

file-type.lisp.

Direct superclasses

error.

Direct subclasses
Direct methods
Direct slots
Slot: code
Initform

(quote -1)

Initargs

:code

Readers

jsonrpc-error-code.

Writers

(setf jsonrpc-error-code).

Slot: message
Initform

(quote "")

Initargs

:message

Readers

jsonrpc-error-message.

Writers

(setf jsonrpc-error-message).

Condition: jsonrpc-internal-error
Package

jsonrpc/errors.

Source

file-type.lisp.

Direct superclasses

jsonrpc-error.

Direct slots
Slot: code
Initform

(quote -32603)

Initargs

:code

Slot: message
Initform

(quote "internal error")

Initargs

:message

Condition: jsonrpc-invalid-params
Package

jsonrpc/errors.

Source

file-type.lisp.

Direct superclasses

jsonrpc-error.

Direct slots
Slot: code
Initform

(quote -32602)

Initargs

:code

Slot: message
Initform

(quote "invalid params")

Initargs

:message

Condition: jsonrpc-invalid-request
Package

jsonrpc/errors.

Source

file-type.lisp.

Direct superclasses

jsonrpc-error.

Direct slots
Slot: code
Initform

(quote -32600)

Initargs

:code

Slot: message
Initform

(quote "invalid request")

Initargs

:message

Condition: jsonrpc-invalid-response
Package

jsonrpc/errors.

Source

file-type.lisp.

Direct superclasses

jsonrpc-error.

Direct slots
Slot: code
Initform

(quote -32000)

Initargs

:code

Slot: message
Initform

(quote "invalid response")

Initargs

:message

Condition: jsonrpc-method-not-found
Package

jsonrpc/errors.

Source

file-type.lisp.

Direct superclasses

jsonrpc-error.

Direct slots
Slot: code
Initform

(quote -32601)

Initargs

:code

Slot: message
Initform

(quote "method not found")

Initargs

:message

Condition: jsonrpc-parse-error
Package

jsonrpc/errors.

Source

file-type.lisp.

Direct superclasses

jsonrpc-error.

Direct slots
Slot: code
Initform

(quote -32700)

Initargs

:code

Slot: message
Initform

(quote "parse error")

Initargs

:message

Condition: jsonrpc-server-error
Package

jsonrpc/errors.

Source

file-type.lisp.

Direct superclasses

jsonrpc-error.


5.1.6 Structures

Structure: request
Package

jsonrpc/request-response.

Source

file-type.lisp.

Direct superclasses

structure-object.

Direct methods
Direct slots
Slot: method
Package

common-lisp.

Readers

request-method.

Writers

(setf request-method).

Slot: params
Readers

request-params.

Writers

(setf request-params).

Slot: id
Readers

request-id.

Writers

(setf request-id).

Structure: response
Package

jsonrpc/request-response.

Source

file-type.lisp.

Direct superclasses

structure-object.

Direct methods
Direct slots
Slot: error
Package

common-lisp.

Readers

response-error.

Writers

(setf response-error).

Slot: result
Readers

response-result.

Writers

(setf response-result).

Slot: id
Readers

response-id.

Writers

(setf response-id).


5.1.7 Classes

Class: client
Package

jsonrpc/class.

Source

file-type.lisp.

Direct superclasses

jsonrpc.

Direct methods
Class: connection
Package

jsonrpc/connection.

Source

file-type.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: socket
Initargs

:socket

Readers

connection-socket.

Writers

(setf connection-socket).

Slot: request-callback
Initargs

:request-callback

Readers

connection-request-callback.

Writers

(setf connection-request-callback).

Slot: request-queue
Initform

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

Readers

connection-request-queue.

Writers

(setf connection-request-queue).

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.

Writers

(setf connection-outbox).

Class: exposable
Package

jsonrpc/mapper.

Source

file-type.lisp.

Direct subclasses

jsonrpc.

Direct methods
Direct slots
Slot: mapper
Initform

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

Readers

exposable-mapper.

Writers

(setf exposable-mapper).

Class: server
Package

jsonrpc/class.

Source

file-type.lisp.

Direct superclasses

jsonrpc.

Direct methods
Direct slots
Slot: client-connections
Initform

(quote nil)

Readers

server-client-connections.

Writers

(setf server-client-connections).

Slot: %lock
Initform

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

Class: transport
Package

jsonrpc/transport/interface.

Source

file-type.lisp.

Direct superclasses

event-emitter.

Direct methods
Direct slots
Slot: message-callback
Initargs

:message-callback

Readers

transport-message-callback.

Writers

(setf transport-message-callback).

Slot: connection
Readers

transport-connection.

Writers

(setf transport-connection).

Slot: threads
Initform

(quote nil)

Readers

transport-threads.

Writers

(setf transport-threads).


5.2 Internals


5.2.1 Special variables

Special Variable: *call-to-error*
Package

jsonrpc/class.

Source

file-type.lisp.

Special Variable: *call-to-result*
Package

jsonrpc/class.

Source

file-type.lisp.

Special Variable: *transport-load-lock*
Package

jsonrpc/utils.

Source

file-type.lisp.


5.2.2 Ordinary functions

Function: copy-request (instance)
Package

jsonrpc/request-response.

Source

file-type.lisp.

Function: copy-response (instance)
Package

jsonrpc/request-response.

Source

file-type.lisp.

Function: ensure-connected (jsonrpc)
Package

jsonrpc/class.

Source

file-type.lisp.

Function: hash-exists-p (hash-table key)
Package

jsonrpc/class.

Source

file-type.lisp.

Function: port-available-p (port)
Package

jsonrpc/utils.

Source

file-type.lisp.

Function: request-p (object)
Package

jsonrpc/request-response.

Source

file-type.lisp.

Function: response-p (object)
Package

jsonrpc/request-response.

Source

file-type.lisp.

Function: set-callback-for-id (connection id callback)
Package

jsonrpc/connection.

Source

file-type.lisp.

Function: valid-request-p (request)
Package

jsonrpc/request-response.

Source

file-type.lisp.

Function: valid-response-p (response)
Package

jsonrpc/request-response.

Source

file-type.lisp.


5.2.3 Generic functions

Generic Reader: exposable-mapper (object)
Package

jsonrpc/mapper.

Methods
Reader Method: exposable-mapper ((exposable exposable))

automatically generated reader method

Source

file-type.lisp.

Target Slot

mapper.

Generic Writer: (setf exposable-mapper) (object)
Package

jsonrpc/mapper.

Methods
Writer Method: (setf exposable-mapper) ((exposable exposable))

automatically generated writer method

Source

file-type.lisp.

Target Slot

mapper.

Generic Function: notify-ready (process-wait)
Package

jsonrpc/connection.

Source

file-type.lisp.

Methods
Method: notify-ready ((process-wait process-wait))
Generic Reader: server-client-connections (object)
Package

jsonrpc/class.

Methods
Reader Method: server-client-connections ((server server))

automatically generated reader method

Source

file-type.lisp.

Target Slot

client-connections.

Generic Writer: (setf server-client-connections) (object)
Package

jsonrpc/class.

Methods
Writer Method: (setf server-client-connections) ((server server))

automatically generated writer method

Source

file-type.lisp.

Target Slot

client-connections.


5.2.4 Classes

Class: jsonrpc
Package

jsonrpc/class.

Source

file-type.lisp.

Direct superclasses
Direct subclasses
Direct methods
Direct slots
Slot: transport
Package

jsonrpc/transport/interface.

Type

(or null jsonrpc/transport/interface:transport)

Initargs

:transport

Readers

jsonrpc-transport.

Writers

(setf jsonrpc-transport).

Class: process-wait
Package

jsonrpc/connection.

Source

file-type.lisp.

Direct subclasses

connection.

Direct methods
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.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   H   J   M   N   P   R   S   T   V   W  
Index Entry  Section

(
(setf connection-outbox): Public generic functions
(setf connection-outbox): Public generic functions
(setf connection-request-callback): Public generic functions
(setf connection-request-callback): Public generic functions
(setf connection-request-queue): Public generic functions
(setf connection-request-queue): Public generic functions
(setf connection-socket): Public generic functions
(setf connection-socket): Public generic functions
(setf exposable-mapper): Private generic functions
(setf exposable-mapper): Private generic functions
(setf jsonrpc-error-code): Public generic functions
(setf jsonrpc-error-code): Public generic functions
(setf jsonrpc-error-message): Public generic functions
(setf jsonrpc-error-message): Public generic functions
(setf jsonrpc-transport): Public generic functions
(setf jsonrpc-transport): Public generic functions
(setf request-id): Public ordinary functions
(setf request-method): Public ordinary functions
(setf request-params): Public ordinary functions
(setf response-error): Public ordinary functions
(setf response-id): Public ordinary functions
(setf response-result): Public ordinary functions
(setf server-client-connections): Private generic functions
(setf server-client-connections): Private generic functions
(setf transport-connection): Public generic functions
(setf transport-connection): Public generic functions
(setf transport-message-callback): Public generic functions
(setf transport-message-callback): Public generic functions
(setf transport-threads): Public generic functions
(setf transport-threads): Public generic functions

A
add-message-to-outbox: Public ordinary functions
add-message-to-queue: Public generic functions
add-message-to-queue: Public generic functions
add-message-to-queue: Public generic functions
add-message-to-queue: Public generic functions

B
bind-server-to-transport: Public ordinary functions
broadcast: Public generic functions
broadcast: Public generic functions

C
call: Public generic functions
call: Public generic functions
call-async: Public generic functions
call-async: Public generic functions
call-async: Public generic functions
call-async-to: Public ordinary functions
call-to: Public generic functions
call-to: Public generic functions
clear-methods: Public generic functions
clear-methods: Public generic functions
client-connect: Public ordinary functions
client-connect-using-class: Public ordinary functions
client-disconnect: Public ordinary functions
connection-outbox: Public generic functions
connection-outbox: Public generic functions
connection-request-callback: Public generic functions
connection-request-callback: Public generic functions
connection-request-queue: Public generic functions
connection-request-queue: Public generic functions
connection-socket: Public generic functions
connection-socket: Public generic functions
copy-request: Private ordinary functions
copy-response: Private ordinary functions

D
dispatch: Public generic functions
dispatch: Public generic functions
dispatch: Public generic functions

E
encode: Public standalone methods
encode: Public standalone methods
encode: Public standalone methods
ensure-connected: Private ordinary functions
exposable-mapper: Private generic functions
exposable-mapper: Private generic functions
expose: Public generic functions
expose: Public generic functions

F
find-mode-class: Public ordinary functions
Function, (setf request-id): Public ordinary functions
Function, (setf request-method): Public ordinary functions
Function, (setf request-params): Public ordinary functions
Function, (setf response-error): Public ordinary functions
Function, (setf response-id): Public ordinary functions
Function, (setf response-result): Public ordinary functions
Function, add-message-to-outbox: Public ordinary functions
Function, bind-server-to-transport: Public ordinary functions
Function, call-async-to: Public ordinary functions
Function, client-connect: Public ordinary functions
Function, client-connect-using-class: Public ordinary functions
Function, client-disconnect: Public ordinary functions
Function, copy-request: Private ordinary functions
Function, copy-response: Private ordinary functions
Function, ensure-connected: Private ordinary functions
Function, find-mode-class: Public ordinary functions
Function, hash-exists-p: Private ordinary functions
Function, make-client: Public ordinary functions
Function, make-error-response: Public ordinary functions
Function, make-id: Public ordinary functions
Function, make-request: Public ordinary functions
Function, make-response: Public ordinary functions
Function, make-server: Public ordinary functions
Function, notify-to: Public ordinary functions
Function, parse-message: Public ordinary functions
Function, port-available-p: Private ordinary functions
Function, random-port: Public ordinary functions
Function, receive-message: Public ordinary functions
Function, request-id: Public ordinary functions
Function, request-method: Public ordinary functions
Function, request-p: Private ordinary functions
Function, request-params: Public ordinary functions
Function, response-error: Public ordinary functions
Function, response-error-code: Public ordinary functions
Function, response-error-message: Public ordinary functions
Function, response-id: Public ordinary functions
Function, response-p: Private ordinary functions
Function, response-result: Public ordinary functions
Function, server-listen: Public ordinary functions
Function, set-callback-for-id: Private ordinary functions
Function, valid-request-p: Private ordinary functions
Function, valid-response-p: Private ordinary functions

G
Generic Function, (setf connection-outbox): Public generic functions
Generic Function, (setf connection-request-callback): Public generic functions
Generic Function, (setf connection-request-queue): Public generic functions
Generic Function, (setf connection-socket): Public generic functions
Generic Function, (setf exposable-mapper): Private generic functions
Generic Function, (setf jsonrpc-error-code): Public generic functions
Generic Function, (setf jsonrpc-error-message): Public generic functions
Generic Function, (setf jsonrpc-transport): Public generic functions
Generic Function, (setf server-client-connections): Private generic functions
Generic Function, (setf transport-connection): Public generic functions
Generic Function, (setf transport-message-callback): Public generic functions
Generic Function, (setf transport-threads): Public generic functions
Generic Function, add-message-to-queue: Public generic functions
Generic Function, broadcast: Public generic functions
Generic Function, call: Public generic functions
Generic Function, call-async: Public generic functions
Generic Function, call-to: Public generic functions
Generic Function, clear-methods: Public generic functions
Generic Function, connection-outbox: Public generic functions
Generic Function, connection-request-callback: Public generic functions
Generic Function, connection-request-queue: Public generic functions
Generic Function, connection-socket: Public generic functions
Generic Function, dispatch: Public generic functions
Generic Function, exposable-mapper: Private generic functions
Generic Function, expose: Public generic functions
Generic Function, jsonrpc-error-code: Public generic functions
Generic Function, jsonrpc-error-message: Public generic functions
Generic Function, jsonrpc-transport: Public generic functions
Generic Function, multicall-async: Public generic functions
Generic Function, notify: Public generic functions
Generic Function, notify-async: Public generic functions
Generic Function, notify-ready: Private generic functions
Generic Function, process-request: Public generic functions
Generic Function, receive-message-using-transport: Public generic functions
Generic Function, register-method: Public generic functions
Generic Function, run-processing-loop: Public generic functions
Generic Function, run-reading-loop: Public generic functions
Generic Function, send-message: Public generic functions
Generic Function, send-message-using-transport: Public generic functions
Generic Function, server-client-connections: Private generic functions
Generic Function, start-client: Public generic functions
Generic Function, start-server: Public generic functions
Generic Function, transport-connection: Public generic functions
Generic Function, transport-message-callback: Public generic functions
Generic Function, transport-threads: Public generic functions
Generic Function, wait-for-ready: Public generic functions

H
hash-exists-p: Private ordinary functions

J
jsonrpc-error-code: Public generic functions
jsonrpc-error-code: Public generic functions
jsonrpc-error-message: Public generic functions
jsonrpc-error-message: Public generic functions
jsonrpc-transport: Public generic functions
jsonrpc-transport: Public generic functions

M
make-client: Public ordinary functions
make-error-response: Public ordinary functions
make-id: Public ordinary functions
make-request: Public ordinary functions
make-response: Public ordinary functions
make-server: Public ordinary functions
Method, (setf connection-outbox): Public generic functions
Method, (setf connection-request-callback): Public generic functions
Method, (setf connection-request-queue): Public generic functions
Method, (setf connection-socket): Public generic functions
Method, (setf exposable-mapper): Private generic functions
Method, (setf jsonrpc-error-code): Public generic functions
Method, (setf jsonrpc-error-message): Public generic functions
Method, (setf jsonrpc-transport): Public generic functions
Method, (setf server-client-connections): Private generic functions
Method, (setf transport-connection): Public generic functions
Method, (setf transport-message-callback): Public generic functions
Method, (setf transport-threads): Public generic functions
Method, add-message-to-queue: Public generic functions
Method, add-message-to-queue: Public generic functions
Method, add-message-to-queue: Public generic functions
Method, broadcast: Public generic functions
Method, call: Public generic functions
Method, call-async: Public generic functions
Method, call-async: Public generic functions
Method, call-to: Public generic functions
Method, clear-methods: Public generic functions
Method, connection-outbox: Public generic functions
Method, connection-request-callback: Public generic functions
Method, connection-request-queue: Public generic functions
Method, connection-socket: Public generic functions
Method, dispatch: Public generic functions
Method, dispatch: Public generic functions
Method, encode: Public standalone methods
Method, encode: Public standalone methods
Method, encode: Public standalone methods
Method, exposable-mapper: Private generic functions
Method, expose: Public generic functions
Method, jsonrpc-error-code: Public generic functions
Method, jsonrpc-error-message: Public generic functions
Method, jsonrpc-transport: Public generic functions
Method, multicall-async: Public generic functions
Method, notify: Public generic functions
Method, notify: Public generic functions
Method, notify-async: Public generic functions
Method, notify-async: Public generic functions
Method, notify-ready: Private generic functions
Method, process-request: Public generic functions
Method, process-request: Public generic functions
Method, run-processing-loop: Public generic functions
Method, run-reading-loop: Public generic functions
Method, send-message: Public generic functions
Method, server-client-connections: Private generic functions
Method, transport-connection: Public generic functions
Method, transport-message-callback: Public generic functions
Method, transport-threads: Public generic functions
Method, wait-for-ready: Public generic functions
multicall-async: Public generic functions
multicall-async: Public generic functions

N
notify: Public generic functions
notify: Public generic functions
notify: Public generic functions
notify-async: Public generic functions
notify-async: Public generic functions
notify-async: Public generic functions
notify-ready: Private generic functions
notify-ready: Private generic functions
notify-to: Public ordinary functions

P
parse-message: Public ordinary functions
port-available-p: Private ordinary functions
process-request: Public generic functions
process-request: Public generic functions
process-request: Public generic functions

R
random-port: Public ordinary functions
receive-message: Public ordinary functions
receive-message-using-transport: Public generic functions
register-method: Public generic functions
request-id: Public ordinary functions
request-method: Public ordinary functions
request-p: Private ordinary functions
request-params: Public ordinary functions
response-error: Public ordinary functions
response-error-code: Public ordinary functions
response-error-message: Public ordinary functions
response-id: Public ordinary functions
response-p: Private ordinary functions
response-result: Public ordinary functions
run-processing-loop: Public generic functions
run-processing-loop: Public generic functions
run-reading-loop: Public generic functions
run-reading-loop: Public generic functions

S
send-message: Public generic functions
send-message: Public generic functions
send-message-using-transport: Public generic functions
server-client-connections: Private generic functions
server-client-connections: Private generic functions
server-listen: Public ordinary functions
set-callback-for-id: Private ordinary functions
start-client: Public generic functions
start-server: Public generic functions

T
transport-connection: Public generic functions
transport-connection: Public generic functions
transport-message-callback: Public generic functions
transport-message-callback: Public generic functions
transport-threads: Public generic functions
transport-threads: Public generic functions

V
valid-request-p: Private ordinary functions
valid-response-p: Private ordinary functions

W
wait-for-ready: Public generic functions
wait-for-ready: Public generic functions


A.3 Variables

Jump to:   %   *  
C   E   I   M   O   P   R   S   T  
Index Entry  Section

%
%lock: Public classes

*
*call-to-error*: Private special variables
*call-to-result*: Private special variables
*connection*: Public special variables
*debug-on-error*: Public special variables
*default-timeout*: Public special variables
*transport-load-lock*: Private special variables

C
client-connections: Public classes
code: Public conditions
code: Public conditions
code: Public conditions
code: Public conditions
code: Public conditions
code: Public conditions
code: Public conditions
condlock: Private classes
condvar: Private classes
connection: Public classes

E
error: Public structures

I
id: Public structures
id: Public structures

M
mapper: Public classes
message: Public conditions
message: Public conditions
message: Public conditions
message: Public conditions
message: Public conditions
message: Public conditions
message: Public conditions
message-callback: Public classes
method: Public structures

O
outbox: Public classes

P
params: Public structures

R
request-callback: Public classes
request-queue: Public classes
response-callback: Public classes
response-lock: Public classes
response-map: Public classes
result: Public structures

S
Slot, %lock: Public classes
Slot, client-connections: Public classes
Slot, code: Public conditions
Slot, code: Public conditions
Slot, code: Public conditions
Slot, code: Public conditions
Slot, code: Public conditions
Slot, code: Public conditions
Slot, code: Public conditions
Slot, condlock: Private classes
Slot, condvar: Private classes
Slot, connection: Public classes
Slot, error: Public structures
Slot, id: Public structures
Slot, id: Public structures
Slot, mapper: Public classes
Slot, message: Public conditions
Slot, message: Public conditions
Slot, message: Public conditions
Slot, message: Public conditions
Slot, message: Public conditions
Slot, message: Public conditions
Slot, message: Public conditions
Slot, message-callback: Public classes
Slot, method: Public structures
Slot, outbox: Public classes
Slot, params: Public structures
Slot, request-callback: Public classes
Slot, request-queue: Public classes
Slot, response-callback: Public classes
Slot, response-lock: Public classes
Slot, response-map: Public classes
Slot, result: Public structures
Slot, socket: Public classes
Slot, threads: Public classes
Slot, transport: Private classes
socket: Public classes
Special Variable, *call-to-error*: Private special variables
Special Variable, *call-to-result*: Private special variables
Special Variable, *connection*: Public special variables
Special Variable, *debug-on-error*: Public special variables
Special Variable, *default-timeout*: Public special variables
Special Variable, *transport-load-lock*: Private special variables

T
threads: Public classes
transport: Private classes


A.4 Data types

Jump to:   C   E   F   J   P   R   S   T  
Index Entry  Section

C
Class, client: Public classes
Class, connection: Public classes
Class, exposable: Public classes
Class, jsonrpc: Private classes
Class, process-wait: Private classes
Class, server: Public classes
Class, transport: Public classes
client: Public classes
Condition, jsonrpc-callback-error: Public conditions
Condition, jsonrpc-error: Public conditions
Condition, jsonrpc-internal-error: Public conditions
Condition, jsonrpc-invalid-params: Public conditions
Condition, jsonrpc-invalid-request: Public conditions
Condition, jsonrpc-invalid-response: Public conditions
Condition, jsonrpc-method-not-found: Public conditions
Condition, jsonrpc-parse-error: Public conditions
Condition, jsonrpc-server-error: Public conditions
connection: Public classes

E
exposable: Public classes

F
File, file-type.lisp: The jsonrpc/main/file-type․lisp file
File, file-type.lisp: The jsonrpc/request-response/file-type․lisp file
File, file-type.lisp: The jsonrpc/errors/file-type․lisp file
File, file-type.lisp: The jsonrpc/transport/interface/file-type․lisp file
File, file-type.lisp: The jsonrpc/connection/file-type․lisp file
File, file-type.lisp: The jsonrpc/class/file-type․lisp file
File, file-type.lisp: The jsonrpc/mapper/file-type․lisp file
File, file-type.lisp: The jsonrpc/utils/file-type․lisp file
File, jsonrpc.asd: The jsonrpc/jsonrpc․asd file
file-type.lisp: The jsonrpc/main/file-type․lisp file
file-type.lisp: The jsonrpc/request-response/file-type․lisp file
file-type.lisp: The jsonrpc/errors/file-type․lisp file
file-type.lisp: The jsonrpc/transport/interface/file-type․lisp file
file-type.lisp: The jsonrpc/connection/file-type․lisp file
file-type.lisp: The jsonrpc/class/file-type․lisp file
file-type.lisp: The jsonrpc/mapper/file-type․lisp file
file-type.lisp: The jsonrpc/utils/file-type․lisp file

J
jsonrpc: The jsonrpc system
jsonrpc: The jsonrpc package
jsonrpc: Private classes
jsonrpc-callback-error: Public conditions
jsonrpc-error: Public conditions
jsonrpc-internal-error: Public conditions
jsonrpc-invalid-params: Public conditions
jsonrpc-invalid-request: Public conditions
jsonrpc-invalid-response: Public conditions
jsonrpc-method-not-found: Public conditions
jsonrpc-params: Private types
jsonrpc-parse-error: Public conditions
jsonrpc-server-error: Public conditions
jsonrpc.asd: The jsonrpc/jsonrpc․asd file
jsonrpc/class: The jsonrpc/class system
jsonrpc/class: The jsonrpc/class package
jsonrpc/connection: The jsonrpc/connection system
jsonrpc/connection: The jsonrpc/connection package
jsonrpc/errors: The jsonrpc/errors system
jsonrpc/errors: The jsonrpc/errors package
jsonrpc/main: The jsonrpc/main system
jsonrpc/mapper: The jsonrpc/mapper system
jsonrpc/mapper: The jsonrpc/mapper package
jsonrpc/request-response: The jsonrpc/request-response system
jsonrpc/request-response: The jsonrpc/request-response package
jsonrpc/transport/interface: The jsonrpc/transport/interface system
jsonrpc/transport/interface: The jsonrpc/transport/interface package
jsonrpc/utils: The jsonrpc/utils system
jsonrpc/utils: The jsonrpc/utils package

P
Package, jsonrpc: The jsonrpc package
Package, jsonrpc/class: The jsonrpc/class package
Package, jsonrpc/connection: The jsonrpc/connection package
Package, jsonrpc/errors: The jsonrpc/errors package
Package, jsonrpc/mapper: The jsonrpc/mapper package
Package, jsonrpc/request-response: The jsonrpc/request-response package
Package, jsonrpc/transport/interface: The jsonrpc/transport/interface package
Package, jsonrpc/utils: The jsonrpc/utils package
process-wait: Private classes

R
request: Public structures
response: Public structures

S
server: Public classes
Structure, request: Public structures
Structure, response: Public structures
System, jsonrpc: The jsonrpc system
System, jsonrpc/class: The jsonrpc/class system
System, jsonrpc/connection: The jsonrpc/connection system
System, jsonrpc/errors: The jsonrpc/errors system
System, jsonrpc/main: The jsonrpc/main system
System, jsonrpc/mapper: The jsonrpc/mapper system
System, jsonrpc/request-response: The jsonrpc/request-response system
System, jsonrpc/transport/interface: The jsonrpc/transport/interface system
System, jsonrpc/utils: The jsonrpc/utils system

T
transport: Public classes
Type, jsonrpc-params: Private types