corda / net.corda.client.rpc

Package net.corda.client.rpc

RPC client interface to Corda, for use both by user-facing client and integration with external systems.

Types

CordaRPCClient

class CordaRPCClient

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

Can be used to configure the RPC client connection.

CordaRPCConnection

class CordaRPCConnection : RPCConnection<CordaRPCOps>

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

GracefulReconnect

class GracefulReconnect

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

RPCConnection

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.

Annotations

RPCSinceVersion

annotation class RPCSinceVersion

Records the protocol version in which this RPC was added.

Exceptions

ConnectionFailureException

open class ConnectionFailureException : RPCException

Signals that the underlying RPCConnection dropped.

MaxRpcRetryException

class MaxRpcRetryException : RPCException

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

PermissionException

class PermissionException : CordaRuntimeException, RpcSerializableError, ClientRelevantError

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

RPCException

open class RPCException : CordaRuntimeException

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

UnrecoverableRPCException

open class UnrecoverableRPCException : RPCException

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

Extensions for External Classes

rx.Observable