ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-05-29 21:54:26 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Docs: misc markup fixes and adjust an out of date paragraph about oracles.

Browse Source
This commit is contained in:
Mike Hearn 2016-05-17 19:40:53 +02:00
parent 5b1b5773ee
commit 06cf7a21be
4 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/index.rst
View File

@ -26,7 +26,7 @@ Read on to learn:
inthebox inthebox
getting-set-up getting-set-up
data-model data-model
consensus consensus
messaging messaging
running-the-demos running-the-demos
node-administration node-administration
@ -36,7 +36,7 @@ Read on to learn:
:maxdepth: 2 :maxdepth: 2
:caption: Tutorials :caption: Tutorials
tutorial_contract tutorial-contract
protocol-state-machines protocol-state-machines
oracles oracles

2
docs/source/node-administration.rst
View File

@ -8,7 +8,7 @@ Monitoring your node
-------------------- --------------------
Like most Java servers, the node exports various useful metrics and management operations via the industry-standard Like most Java servers, the node exports various useful metrics and management operations via the industry-standard
`JMX infrastructure <https://en.wikipedia.org/wiki/Java_Management_Extensions>`_. JMX is a standard _in-process_ API `JMX infrastructure <https://en.wikipedia.org/wiki/Java_Management_Extensions>`_. JMX is a standard API
for registering so-called _MBeans_ ... objects whose properties and methods are intended for server management. It does for registering so-called _MBeans_ ... objects whose properties and methods are intended for server management. It does
not require any particular network protocol for export. So this data can be exported from the node in various ways: not require any particular network protocol for export. So this data can be exported from the node in various ways:
some monitoring systems provide a "Java Agent", which is essentially a JVM plugin that finds all the MBeans and sends some monitoring systems provide a "Java Agent", which is essentially a JVM plugin that finds all the MBeans and sends

10
docs/source/oracles.rst
View File

@ -176,11 +176,11 @@ Implementation involves the following steps:
2. Defining a lower level service class, that binds network messages to the API. 2. Defining a lower level service class, that binds network messages to the API.
3. Defining a protocol using the :doc:`protocol-state-machines` framework to make it easy for a client to interact 3. Defining a protocol using the :doc:`protocol-state-machines` framework to make it easy for a client to interact
with the oracle. with the oracle.
4. Constructing it (when advertised) in ``AbstractNode``.
An example of how to do this can be found in the ``NodeInterestRates.Oracle``, ``NodeInterestRates.Service`` and An example of how to do this can be found in the ``NodeInterestRates.Oracle``, ``NodeInterestRates.Service`` and
``RateFixProtocol`` classes. The exact details of how this code works will change in future, so for now consulting ``RateFixProtocol`` classes.
the protocols tutorial and the code for the server-side oracles implementation will have to suffice. There will be more
detail added once the platform APIs have settled down.
Currently, there's no network map service, so the location and identity keys of an oracle must be distributed out of The exact details of how this code works will change in future, so for now consulting the protocols tutorial and the
band. code for the server-side oracles implementation will have to suffice. There will be more detail added once the
platform APIs have settled down.

0
docs/source/tutorial_contract.rst → docs/source/tutorial-contract.rst
View File