docs/net.corda.client.rpc/RPCConnection

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.

Closeable.close may be used to shut down the connection and release associated resources. It is an alias for notifyServerAndClose.

Inheritors

CordaRPCConnection

ReconnectingRPCConnection

Properties

proxy

abstract val proxy: I

Holds a synthetic class that automatically forwards method calls to the server, and returns the response.

serverProtocolVersion

abstract val serverProtocolVersion: Int

The RPC protocol version reported by the server.

Functions

open override fun close()

forceClose

abstract fun forceClose()

Closes this client without notifying the server.

getTelemetryHandle

abstract fun <T> getTelemetryHandle(telemetryClass: Class<T>): T?

Returns the configured openTelemetry global. Returns null if opentelemetry has not been configured.

notifyServerAndClose

abstract fun notifyServerAndClose()

Closes this client gracefully by sending a notification to the server, so it can immediately clean up resources. If the server is not available this method may block for a short period until it's clear the server is not coming back.