Updated KDoc for quick RPCs

This commit is contained in:
Chris Cochrane 2022-08-18 13:02:20 +01:00
parent 6d0875076f
commit 14e2ef3478
No known key found for this signature in database
GPG Key ID: 4D4602B5BBC63950
2 changed files with 10 additions and 2 deletions

View File

@ -392,7 +392,11 @@ interface CordaRPCOps : RPCOps {
/** Queries attachments metadata */
fun queryAttachments(query: AttachmentQueryCriteria, sorting: AttachmentSort?): List<AttachmentId>
/** Returns the node's current time. */
/** Returns the node's current time.
*
* Is a quick RPC, meaning that it is handled outside the node's standard thread pool in order to provide a
* quick response even when the node is dealing with a high volume of RPC calls.
*/
fun currentNodeTime(): Instant
/**

View File

@ -8,6 +8,10 @@ import net.corda.core.DoNotImplement
*/
@DoNotImplement
interface RPCOps {
/** Returns the RPC protocol version. Exists since version 0 so guaranteed to be present. */
/** Returns the RPC protocol version. Exists since version 0 so guaranteed to be present.
*
* Getting this property is handled as a quick RPC, meaning that it is handled outside the node's standard
* thread pool in order to provide a quick response even when the node is dealing with a high volume of RPC calls.
*/
val protocolVersion: Int
}