Skip to content

Commit 0430469

Browse files
Read-only nodes (#2380)
* DOC-6694 - added new read-only nodes topic. Added the isReadNote command to the api-rpc.md topic. Also other changes due to renumbering topics. * DOC-6694 - added release notes for read-only nodes * DOC-6694 - minor * Apply suggestions from code review Co-authored-by: Lajos Veres <vlajos@gmail.com> * Update content/en/platform/corda/4.13/enterprise/node/setup/corda-configuration-fields.md Co-authored-by: Lajos Veres <vlajos@gmail.com> --------- Co-authored-by: Lajos Veres <vlajos@gmail.com>
1 parent ace5446 commit 0430469

File tree

13 files changed

+242
-116
lines changed

13 files changed

+242
-116
lines changed

content/en/platform/corda/4.13/enterprise/api-rpc.md

Lines changed: 13 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -18,50 +18,16 @@ access to the node’s `ServiceHub`.
1818

1919
The key RPC operations exposed by the node are:
2020

21-
22-
* `CordaRPCOps.vaultQueryBy`
23-
* Extract states from the node’s vault based on a query criteria
24-
25-
26-
* `CordaRPCOps.vaultTrackBy`
27-
* As above, but also returns an observable of future states matching the query
28-
29-
30-
* `CordaRPCOps.networkMapFeed`
31-
* A list of network nodes, and an observable of changes to the network map
32-
33-
34-
* `CordaRPCOps.registeredFlows`
35-
* See a list of registered flows on the node
36-
37-
38-
* `CordaRPCOps.startFlowDynamic`
39-
* Start one of the node’s registered flows
40-
41-
42-
* `CordaRPCOps.startTrackedFlowDynamic`
43-
* As above, but also returns a progress handle for the flow
44-
45-
46-
* `CordaRPCOps.nodeDiagnosticInfo`
47-
* Returns diagnostic information about the node, including the version and CorDapp details
48-
49-
50-
* `CordaRPCOps.nodeInfo`
51-
* Returns the network map entry of the node, including its address and identity details as well as the platform version information
52-
53-
54-
* `CordaRPCOps.currentNodeTime`
55-
* Returns the current time according to the node’s clock. It is a 'quick RPC'. It bypasses the thread pool and other regular RPCs waiting in it, allowing the node to reply relatively quickly.
56-
57-
58-
* `CordaRPCOps.partyFromKey/CordaRPCOps.wellKnownPartyFromX500Name`
59-
* Retrieves a party on the network based on a public key or X500 name
60-
61-
62-
* `CordaRPCOps.uploadAttachment`/`CordaRPCOps.openAttachment`/`CordaRPCOps.attachmentExists`
63-
* Uploads, opens and checks for the existence of attachments
64-
65-
* `CordaRPCOps.killFlow()`
66-
* Attempts to kill a flow. This is not a clean termination and should be reserved for exceptional cases such as stuck fibers. Returns whether the flow existed and was killed.
67-
21+
- `CordaRPCOps.currentNodeTime`: Returns the current time according to the node’s clock. It is a 'quick RPC'. It bypasses the thread pool and other regular RPCs waiting in it, allowing the node to reply relatively quickly.
22+
- `CordaRPCOps.isReadOnlyNode`: Allows you to check the [read-only status]({{< relref "node/setup/read-only-nodes.md" >}}) of a node. It returns true if the node is configured as read-only, otherwise false
23+
- `CordaRPCOps.killFlow()`: Attempts to kill a flow. This is not a clean termination and should be reserved for exceptional cases such as stuck fibers. Returns whether the flow existed and was killed.
24+
- `CordaRPCOps.networkMapFeed`: Returns a list of network nodes and observable changes to the network map
25+
- `CordaRPCOps.nodeDiagnosticInfo`: Returns diagnostic information about the node, including the version and CorDapp details
26+
- `CordaRPCOps.nodeInfo`: Returns the network map entry of the node, including its address and identity details as well as the platform version information
27+
- `CordaRPCOps.partyFromKey/CordaRPCOps.wellKnownPartyFromX500Name`: Retrieves a party on the network based on a public key or X.500 name
28+
- `CordaRPCOps.registeredFlows`: Returns a list of registered flows on the node
29+
- `CordaRPCOps.startFlowDynamic`: Start one of the node’s registered flows
30+
- `CordaRPCOps.startTrackedFlowDynamic`: The same as `startFlowDynamic` above, but also returns a progress handle for the flow
31+
- `CordaRPCOps.uploadAttachment`/`CordaRPCOps.openAttachment`/`CordaRPCOps.attachmentExists`: Uploads, opens and checks for the existence of attachments
32+
- `CordaRPCOps.vaultQueryBy`: Extract states from the node’s vault based on a query criteria
33+
- `CordaRPCOps.vaultTrackBy`: The same as `vaultQueryBy` above, but also returns an observable of future states matching the query

content/en/platform/corda/4.13/enterprise/messaging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
tags:
77
- messaging
88
title: Networking and messaging
9-
weight: 140
9+
weight: 1400
1010
---
1111

1212

content/en/platform/corda/4.13/enterprise/node-services.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ tags:
77
- node
88
- services
99
title: Node services
10-
weight: 180
10+
weight: 1800
1111
---
1212

1313

content/en/platform/corda/4.13/enterprise/node/operating/clientrpc.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -741,3 +741,7 @@ Note that RPC TLS does not use mutual authentication, and delegates fine-grained
741741
CorDapps must whitelist any classes used over RPC with Corda’s serialization framework, unless they are whitelisted by
742742
default in `DefaultWhitelist`. The whitelisting is done either via the plugin architecture or by using the
743743
`@CordaSerializable` annotation (see [Serialization]({{< relref "../../../../../../../en/platform/corda/4.13/enterprise/serialization-index.md" >}})). An example is shown in [Working with the CordaRPCClient API]({{< relref "../../get-started/tutorials/supplementary-tutorials/tutorial-clientrpc-api.md" >}}).
744+
745+
## RPC operations list
746+
747+
For a list of the key RPC operations available, see [RPC operations]({{< relref "../../api-rpc.md" >}}).

0 commit comments

Comments
 (0)