docs/net.corda.client.rpc.internal/RPCClient

RPCClient

class RPCClient<I : RPCOps>(transport: <Error class: unknown class>, rpcConfiguration: CordaRPCClientConfiguration = CordaRPCClientConfiguration.DEFAULT, serializationContext: SerializationContext = SerializationDefaults.RPC_CLIENT_CONTEXT, haPoolTransportConfigurations: List<<Error class: unknown class>> = emptyList())

RPCClient is meant to run outside of Corda Node JVM and provide connectivity to a node using RPC protocol. Since Corda Node can expose multiple RPC interfaces, it is possible to specify which RPCOps interface should be used.

When haAddressPool RPCClient will perform connectivity failover using parameters specified by CordaRPCClientConfiguration. Whenever status of connection changes registered RPCConnectionListener will be informed about those events.

Constructors

Link copied to clipboard
constructor(hostAndPort: NetworkHostAndPort, sslConfiguration: ClientRpcSslOptions? = null, configuration: CordaRPCClientConfiguration = CordaRPCClientConfiguration.DEFAULT, serializationContext: SerializationContext = SerializationDefaults.RPC_CLIENT_CONTEXT)
constructor(hostAndPort: NetworkHostAndPort, sslConfiguration: <Error class: unknown class>, configuration: CordaRPCClientConfiguration = CordaRPCClientConfiguration.DEFAULT, serializationContext: SerializationContext = SerializationDefaults.RPC_CLIENT_CONTEXT)
constructor(haAddressPool: List<NetworkHostAndPort>, sslConfiguration: ClientRpcSslOptions? = null, configuration: CordaRPCClientConfiguration = CordaRPCClientConfiguration.DEFAULT, serializationContext: SerializationContext = SerializationDefaults.RPC_CLIENT_CONTEXT)

A way to create RPC connections to a pool of RPC addresses for resiliency

constructor(transport: <Error class: unknown class>, rpcConfiguration: CordaRPCClientConfiguration = CordaRPCClientConfiguration.DEFAULT, serializationContext: SerializationContext = SerializationDefaults.RPC_CLIENT_CONTEXT, haPoolTransportConfigurations: List<<Error class: unknown class>> = emptyList())

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun addConnectionListener(listener: RPCConnectionListener<I>): Boolean

Adds RPCConnectionListener to this RPCClient to be informed about important connectivity events.

Link copied to clipboard
Link copied to clipboard
fun start(rpcOpsClass: Class<I>, username: String, password: String, externalTrace: Trace? = null, impersonatedActor: Actor? = null, targetLegalIdentity: CordaX500Name? = null): RPCConnection<I>