Module convex.peer

Package convex.api

Class ConvexRemote

java.lang.Object

convex.api.Convex

convex.api.ConvexRemote

All Implemented Interfaces:

AutoCloseable

public class ConvexRemote
extends Convex

Convex client API implementation for peers accessed over a network connection using the Convex binary peer protocol

Field Summary

Fields

Modifier and Type	Field	Description
protected AConnection	connection	Current Connection to a Peer, may be null or a closed connection.
protected static final org.slf4j.Logger	log
protected InetSocketAddress	remoteAddress
protected final Consumer<Message>	returnMessageHandler	Result handler for Messages received back from a remote connection

Fields inherited from class convex.api.Convex

address, idCounter, keyPair, preCompile, sequence, timeout

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConvexRemote(Address address, AKeyPair keyPair)

Method Summary

Modifier and Type	Method	Description
<T extends ACell> CompletableFuture<T>	acquire(Hash hash, AStore store)	Attempts to acquire a complete persistent data structure for the given hash from the connected peer.
CompletableFuture<State>	acquireState()	Gets the consensus state from the connected Peer.
void	close()	Disconnects the client from the network, closing the underlying connection.
static ConvexRemote	connect(InetSocketAddress peerAddress)
static ConvexRemote	connectNetty(InetSocketAddress sa)
static ConvexRemote	connectNIO(InetSocketAddress sa)
protected void	connectToPeer(InetSocketAddress peerAddress)
InetSocketAddress	getHostAddress()	Gets the remote address for this Convex client instance
Server	getLocalServer()	Gets the local Server instance, or null if not a local connection
boolean	isConnected()	Checks if this Convex client instance has an open remote connection.
CompletableFuture<Result>	message(Message m)	Submits a Message to the connected peer, returning a Future for any Result
CompletableFuture<Result>	messageRaw(Blob message)	Submits raw message data to the Convex network, returning a Future for any Result
CompletableFuture<Result>	query(ACell query, Address address)	Submits a query to the Convex network, returning a Future once the query has been successfully queued.
void	reconnect()
CompletableFuture<Result>	requestChallenge(SignedData<ACell> data)	Request a challenge.
CompletableFuture<Result>	requestStatus()	Submits a status request to the Convex network peer, returning a Future once the request has been successfully queued.
protected void	setConnection(AConnection conn)	Sets the current Connection for this Remote Client
String	toString()
CompletableFuture<Result>	transact(SignedData<ATransaction> signed)	Submits a signed transaction to the Convex network, returning a Future once the transaction has been successfully queued.

Methods inherited from class convex.api.Convex

acquire, clearSequence, connect, connect, connect, connect, createAccount, createAccountSync, finalize, getAccountKey, getAccountKey, getAddress, getBalance, getBalance, getKeyPair, getNextID, getSequence, getSequence, getTimeout, isAutoSequence, isPreCompile, lookupSequence, maybeUpdateSequence, preCompile, prepareTransaction, prepareTransaction, query, query, querySync, querySync, querySync, querySync, requestStatusSync, requestStatusSync, resolve, setAddress, setAddress, setAutoSequence, setKeyPair, setNextSequence, setPreCompile, setTimeout, signData, transact, transact, transact, transactSync, transactSync, transactSync, transactSync, transactSync, transfer, transferSync

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

connection

protected AConnection connection

Current Connection to a Peer, may be null or a closed connection.

log

protected static final org.slf4j.Logger log

remoteAddress

protected InetSocketAddress remoteAddress

returnMessageHandler

protected final Consumer<Message> returnMessageHandler

Result handler for Messages received back from a remote connection

Constructor Details

ConvexRemote

protected ConvexRemote(Address address,
 AKeyPair keyPair)

Method Details

getHostAddress

public InetSocketAddress getHostAddress()

Description copied from class: Convex

Gets the remote address for this Convex client instance

Specified by:

getHostAddress in class Convex

Returns:

Socket address

connectToPeer

protected void connectToPeer(InetSocketAddress peerAddress)
                      throws IOException,
TimeoutException,
InterruptedException

Throws:

IOException

TimeoutException

InterruptedException

connect

public static ConvexRemote connect(InetSocketAddress peerAddress)
                            throws IOException,
TimeoutException,
InterruptedException

Throws:

IOException

TimeoutException

InterruptedException

connectNetty

public static ConvexRemote connectNetty(InetSocketAddress sa)
                                 throws InterruptedException,
IOException

Throws:

InterruptedException

IOException

connectNIO

public static ConvexRemote connectNIO(InetSocketAddress sa)
                               throws InterruptedException,
IOException,
TimeoutException

Throws:

InterruptedException

IOException

TimeoutException

reconnect

public void reconnect()
               throws IOException,
TimeoutException,
InterruptedException

Specified by:

reconnect in class Convex

Throws:

IOException

TimeoutException

InterruptedException

setConnection

protected void setConnection(AConnection conn)

Sets the current Connection for this Remote Client

Parameters:

conn - Connection value to use

isConnected

public boolean isConnected()

Checks if this Convex client instance has an open remote connection.

Specified by:

isConnected in class Convex

Returns:

true if connected, false otherwise

acquireState

public CompletableFuture<State> acquireState()

Description copied from class: Convex

Gets the consensus state from the connected Peer. The acquired state will be a snapshot of the network global state as calculated by the Peer. SECURITY: Be aware that if this client instance is connected to an untrusted Peer, the Peer may lie about the latest state. If this is a security concern, the client should validate the consensus state independently.

Overrides:

acquireState in class Convex

Returns:

Future for consensus state

transact

public CompletableFuture<Result> transact(SignedData<ATransaction> signed)

Description copied from class: Convex

Submits a signed transaction to the Convex network, returning a Future once the transaction has been successfully queued. Updates cached sequence number on best effort basis.

Specified by:

transact in class Convex

Parameters:

signed - Signed transaction to execute

Returns:

A Future for the result of the transaction

query

public CompletableFuture<Result> query(ACell query,
 Address address)

Description copied from class: Convex

Submits a query to the Convex network, returning a Future once the query has been successfully queued.

Specified by:

query in class Convex

Parameters:

query - Query to execute, as a Form or Op

address - Address to use for the query

Returns:

A Future for the result of the query

messageRaw

public CompletableFuture<Result> messageRaw(Blob message)

Description copied from class: Convex

Submits raw message data to the Convex network, returning a Future for any Result

Specified by:

messageRaw in class Convex

Parameters:

message - Raw message data

Returns:

A Future for the result of the query

message

public CompletableFuture<Result> message(Message m)

Description copied from class: Convex

Submits a Message to the connected peer, returning a Future for any Result

Specified by:

message in class Convex

Parameters:

m - Message data

Returns:

A Future for the Result of the query. May just be "Sent" if no other result expected, or an immediate error if sending failed.

requestStatus

public CompletableFuture<Result> requestStatus()

Description copied from class: Convex

Submits a status request to the Convex network peer, returning a Future once the request has been successfully queued.

Specified by:

requestStatus in class Convex

Returns:

A Future for the result of the requestStatus

requestChallenge

public CompletableFuture<Result> requestChallenge(SignedData<ACell> data)

Description copied from class: Convex

Request a challenge. This is request is made by any peer that needs to find out if another peer can be trusted.

Specified by:

requestChallenge in class Convex

Parameters:

data - Signed data to send to the peer for the challenge.

Returns:

A Future for the result of the requestChallenge

acquire

public <T extends ACell> CompletableFuture<T> acquire(Hash hash,
 AStore store)

Description copied from class: Convex

Attempts to acquire a complete persistent data structure for the given hash from the connected peer. Uses the store provided as a destination.

Specified by:

acquire in class Convex

Parameters:

hash - Hash of value to acquire.

store - Store to acquire the persistent data to.

Returns:

Future for the Cell being acquired. May fail exceptionally or timeout if the given data cannot be acquired (most likely missing from the peer's store)

close

public void close()

Disconnects the client from the network, closing the underlying connection.

Specified by:

close in interface AutoCloseable

Specified by:

close in class Convex

toString

public String toString()

Specified by:

toString in class Convex

getLocalServer

public Server getLocalServer()

Description copied from class: Convex

Gets the local Server instance, or null if not a local connection

Overrides:

getLocalServer in class Convex

Returns:

Server instance (or null)