ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-30 17:57:02 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
e28478c983
corda/docs/source/api-rpc.rst
gwr3com 933330bc4c CORDA-3028: Add Node Diagnostics Info RPC Call (#5271) 
* CORDA-3028: Add Node Diagnostics Info RPC Call - Initial commit

* CORDA-3028: Add Node Diagnostics Info RPC Call - Changes after code review

* CORDA-3028: Add Node Diagnostics Info RPC Call - Additional code review update and documentation

* CORDA-3028: Add Node Diagnostics Info RPC Call - Additional changes to documentation

* CORDA-3028: Add Node Diagnostics Info RPC Call - Another change to documentation

* CORDA-3028: Add Node Diagnostics Info RPC Call - More changes to documentation

* CORDA-3028: Add Node Diagnostics Info RPC Call - Comment change
2019-07-08 14:43:50 +01:00

1.5 KiB
Raw Blame History

API: RPC operations

The node's owner interacts with the node solely via remote procedure calls (RPC). The node's owner does not have 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
  • 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