зеркало из https://github.com/microsoft/CCF.git
Update documentation (#627)
This commit is contained in:
Родитель
3f0edba271
Коммит
b816666f0f
|
@ -52,6 +52,8 @@ extensions = [
|
|||
"sphinx-jsonschema",
|
||||
]
|
||||
|
||||
autosectionlabel_prefix_document = True
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ["_templates"]
|
||||
|
||||
|
|
|
@ -6,21 +6,31 @@ CCF provides two client implementations (C++ and Python).
|
|||
C++ Client
|
||||
----------
|
||||
|
||||
.. doxygenclass:: RpcTlsClient
|
||||
.. doxygenclass:: JsonRpcTlsClient
|
||||
:project: CCF
|
||||
:members:
|
||||
|
||||
Alternatively, the ``SigRpcTlsClient`` can be used to issue signed requests (useful for governance).
|
||||
Alternatively, the ``SigJsonRpcTlsClient`` can be used to issue signed requests (useful for governance).
|
||||
|
||||
.. doxygenclass:: SigRpcTlsClient
|
||||
.. doxygenclass:: SigJsonRpcTlsClient
|
||||
:project: CCF
|
||||
:members:
|
||||
|
||||
Python Client
|
||||
-------------
|
||||
|
||||
Available as part of CCF Python infra: https://github.com/microsoft/CCF/blob/master/tests/infra/jsonrpc.py.
|
||||
Available as part of CCF Python infra: https://github.com/microsoft/CCF/blob/master/tests/infra/clients.py.
|
||||
|
||||
The ``Checker`` class in `ccf.py <https://github.com/microsoft/CCF/blob/master/tests/infra/ccf.py>`_ can be used as a wrapper to wait for requests to be committed.
|
||||
|
||||
.. warning:: The Python client does not yet support signed requests.
|
||||
HTTP
|
||||
----
|
||||
|
||||
HTTP support is now available experimentally in CCF. To enable it, follow the standard build procedure, and passing `-DHTTP=ON` to cmake.
|
||||
|
||||
Testcases will automatically switch to using the appropriate clients.
|
||||
The CCF Python infra client can be used without any modifications other than exporting the ``HTTP`` environment variable.
|
||||
By default, the Python infra uses `requests <https://realpython.com/python-requests/>`_, but exporting the ``CURL_CLIENT`` environment variable will switch to a ``curl``-based client instead.
|
||||
|
||||
The ``start_test_network.sh`` script documented in :ref:`Quickstart` defaults to using ``curl``.
|
||||
A simple ``scurl.sh`` wrapper script is automatically generated under ``build/``, and allows sending signed requests to CCF.
|
Загрузка…
Ссылка в новой задаче