Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 13 additions & 47 deletions content/en/platform/corda/4.13/enterprise/api-rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,50 +18,16 @@ access to the node’s `ServiceHub`.

The key RPC operations exposed by the node are:


* `CordaRPCOps.vaultQueryBy`
* Extract states from the node’s vault based on a query criteria


* `CordaRPCOps.vaultTrackBy`
* As above, but also returns an observable of future states matching the query


* `CordaRPCOps.networkMapFeed`
* A list of network nodes, and an observable of changes to the network map


* `CordaRPCOps.registeredFlows`
* See a list of registered flows on the node


* `CordaRPCOps.startFlowDynamic`
* Start one of the node’s registered flows


* `CordaRPCOps.startTrackedFlowDynamic`
* As above, but also returns a progress handle for the flow


* `CordaRPCOps.nodeDiagnosticInfo`
* Returns diagnostic information about the node, including the version and CorDapp details


* `CordaRPCOps.nodeInfo`
* Returns the network map entry of the node, including its address and identity details as well as the platform version information


* `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.


* `CordaRPCOps.partyFromKey/CordaRPCOps.wellKnownPartyFromX500Name`
* Retrieves a party on the network based on a public key or X500 name


* `CordaRPCOps.uploadAttachment`/`CordaRPCOps.openAttachment`/`CordaRPCOps.attachmentExists`
* Uploads, opens and checks for the existence of attachments

* `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.

- `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.
- `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
- `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.
- `CordaRPCOps.networkMapFeed`: Returns a list of network nodes and observable changes to the network map
- `CordaRPCOps.nodeDiagnosticInfo`: Returns diagnostic information about the node, including the version and CorDapp details
- `CordaRPCOps.nodeInfo`: Returns the network map entry of the node, including its address and identity details as well as the platform version information
- `CordaRPCOps.partyFromKey/CordaRPCOps.wellKnownPartyFromX500Name`: Retrieves a party on the network based on a public key or X.500 name
- `CordaRPCOps.registeredFlows`: Returns a list of registered flows on the node
- `CordaRPCOps.startFlowDynamic`: Start one of the node’s registered flows
- `CordaRPCOps.startTrackedFlowDynamic`: The same as `startFlowDynamic` above, but also returns a progress handle for the flow
- `CordaRPCOps.uploadAttachment`/`CordaRPCOps.openAttachment`/`CordaRPCOps.attachmentExists`: Uploads, opens and checks for the existence of attachments
- `CordaRPCOps.vaultQueryBy`: Extract states from the node’s vault based on a query criteria
- `CordaRPCOps.vaultTrackBy`: The same as `vaultQueryBy` above, but also returns an observable of future states matching the query
2 changes: 1 addition & 1 deletion content/en/platform/corda/4.13/enterprise/messaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ menu:
tags:
- messaging
title: Networking and messaging
weight: 140
weight: 1400
---


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:
- node
- services
title: Node services
weight: 180
weight: 1800
---


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -741,3 +741,7 @@ Note that RPC TLS does not use mutual authentication, and delegates fine-grained
CorDapps must whitelist any classes used over RPC with Corda’s serialization framework, unless they are whitelisted by
default in `DefaultWhitelist`. The whitelisting is done either via the plugin architecture or by using the
`@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" >}}).

## RPC operations list

For a list of the key RPC operations available, see [RPC operations]({{< relref "../../api-rpc.md" >}}).
Loading