docs/net.corda.client.rpc

Package-level declarations

Types

open class ConnectionFailureException(cause: Throwable? = null) : RPCException

Signals that the underlying RPCConnection dropped.

An RPC client connects to the specified server and allows you to make calls to the server that perform various useful tasks. Please see the Client RPC section of docs.corda.net to learn more about how this API works. A brief description is provided here.

CordaRPCClientConfiguration

open class CordaRPCClientConfiguration constructor(val connectionMaxRetryInterval: Duration = 3.minutes, val minimumServerProtocolVersion: Int = PLATFORM_VERSION, val trackRpcCallSites: Boolean = java.lang.Boolean.getBoolean("net.corda.client.rpc.trackRpcCallSites"), val reapInterval: Duration = 1.seconds, val observationExecutorPoolSize: Int = 4, cacheConcurrencyLevel: Int = 1, val connectionRetryInterval: Duration = 5.seconds, val connectionRetryIntervalMultiplier: Double = 1.5, val maxReconnectAttempts: Int = unlimitedReconnectAttempts, val maxFileSize: Int = 10485760, val deduplicationCacheExpiry: Duration = 1.days, val openTelemetryEnabled: Boolean = true, val simpleLogTelemetryEnabled: Boolean = false, val spanStartEndEventsEnabled: Boolean = false, val copyBaggageToTags: Boolean = false)

Can be used to configure the RPC client connection.

CordaRPCConnection

class CordaRPCConnection : RPCConnection<CordaRPCOps>

This class is essentially just a wrapper for an RPCConnection<CordaRPCOps> and can be treated identically.

GracefulReconnect

class GracefulReconnect(val onDisconnect: () -> Unit = {}, val onReconnect: () -> Unit = {}, val maxAttempts: Int = 5)

GracefulReconnect provides the opportunity to perform certain logic when the RPC encounters a connection disconnect during communication with the node.

MaxRpcRetryException

class MaxRpcRetryException(maxNumberOfRetries: Int, method: Method, cause: Throwable?) : RPCException

Thrown to indicate an RPC operation has been retried for the maxNumberOfRetries unsuccessfully.

PermissionException

class PermissionException(val msg: String) : CordaRuntimeException, ClientRelevantError

Thrown to indicate that the calling user does not have permission for something they have requested (for example calling a method).

RPCConnection

@DoNotImplement

interface RPCConnection<out I : RPCOps> : Closeable

Holds a proxy object implementing I that forwards requests to the RPC server. The server version can be queried via this interface.

RPCException

open class RPCException(message: String?, cause: Throwable?) : CordaRuntimeException

Thrown to indicate a fatal error in the RPC system itself, as opposed to an error generated by the invoked method.

RPCSinceVersion

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class RPCSinceVersion(val version: Int)

Records the protocol version in which this RPC was added.

UnrecoverableRPCException

open class UnrecoverableRPCException(message: String?, cause: Throwable? = null) : RPCException

Thrown to indicate a fatal error in the RPC system which cannot be recovered from and so needs some manual support.

Functions

notUsed

fun <T> <Error class: unknown class><T>.notUsed()

This function should be invoked on any unwanted Observables returned from RPC to release the server resources.