net.corda.client.rpc

Interface RPCConnection<I>

All Known Implementing Classes:

CordaRPCConnection

public RPCConnection<I>

Holds a RPCConnection.getProxy 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 RPCConnection.notifyServerAndClose.

See Also:

RPCConnection.getProxy, Closeable.close, RPCConnection.notifyServerAndClose

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RPCConnection.DefaultImpls Holds a RPCConnection.getProxy object implementing I that forwards requests to the RPC server. The server version can be queried via this interface.

Method Summary

Modifier and Type	Method and Description
void	close()
void	forceClose() Closes this client without notifying the server.
I	getProxy() Holds a synthetic class that automatically forwards method calls to the server, and returns the response.
int	getServerProtocolVersion() The RPC protocol version reported by the server.
void	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.

Method Detail

getProxy

I getProxy()

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

getServerProtocolVersion

int getServerProtocolVersion()

The RPC protocol version reported by the server.

notifyServerAndClose

void 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.

Note: this will also be the implementation of RPCConnection.close so won't be needed when using use or try-with-resources blocks.

See Also:

RPCConnection.close, use

forceClose

void forceClose()

Closes this client without notifying the server.

The server will eventually clear out the RPC message queue and disconnect subscribed observers, but this may take longer than desired, so to conserve resources you should normally use RPCConnection.notifyServerAndClose. This method is helpful when the node may be shutting down or have already shut down and you don't want to block waiting for it to come back, which typically happens in integration tests and demos rather than production.

See Also:

RPCConnection.notifyServerAndClose

close

void close()