2022-06-04 08:41:53 +00:00
|
|
|
API Documentation
|
|
|
|
|
=================
|
|
|
|
|
|
|
|
|
|
.. module:: bthlabs_jsonrpc_core
|
|
|
|
|
|
|
|
|
|
This section provides the API documentation for BTHLabs JSONRPC - Core.
|
|
|
|
|
|
2024-01-15 20:20:10 +00:00
|
|
|
Codecs
|
|
|
|
|
------
|
|
|
|
|
|
|
|
|
|
.. autoclass:: Codec
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. autoclass:: JSONCodec
|
|
|
|
|
:members:
|
|
|
|
|
|
2022-06-04 08:41:53 +00:00
|
|
|
Decorators
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
.. autofunction:: register_method
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Exceptions
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
.. autoexception:: BaseJSONRPCError
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. autoexception:: JSONRPCAccessDeniedError
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. autoexception:: JSONRPCInternalError
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. autoexception:: JSONRPCParseError
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. autoexception:: JSONRPCSerializerError
|
|
|
|
|
:members:
|
|
|
|
|
|
2024-01-15 20:20:10 +00:00
|
|
|
Executors
|
|
|
|
|
---------
|
2022-06-04 08:41:53 +00:00
|
|
|
|
|
|
|
|
.. autoclass:: Executor
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
|
2024-01-15 20:20:10 +00:00
|
|
|
Registries
|
2022-06-04 08:41:53 +00:00
|
|
|
----------
|
|
|
|
|
|
2024-01-15 20:20:10 +00:00
|
|
|
|
|
|
|
|
.. autoclass:: MethodRegistry
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Serializers
|
|
|
|
|
-----------
|
|
|
|
|
|
2022-06-04 08:41:53 +00:00
|
|
|
.. autoclass:: JSONRPCSerializer
|
|
|
|
|
:members:
|
