Package convex.api

Class ConvexRemote

java.lang.Object

convex.api.Convex

convex.api.ConvexRemote

public class ConvexRemote
extends Convex

Field Summary

Fields

Modifier and Type	Field	Description
protected Connection	connection	Current Connection to a Peer, may be null or a closed connection.
protected InetSocketAddress	remoteAddress

Fields inherited from class convex.api.Convex

address, awaiting, keyPair, messageHandler, 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.
void	closeButMaintainConnection()	Close without affecting the underlying connection (will be unlinked but not closed)
protected void	connectToPeer(InetSocketAddress peerAddress, AStore store)
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>	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(Connection 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, awaitResult, connect, connect, connect, connect, connect, createAccount, createAccountSync, finalize, getAccountKey, getAccountKey, getAddress, getBalance, getBalance, getKeyPair, getSequence, getSequence, isAutoSequence, lookupSequence, maybeUpdateSequence, prepareTransaction, query, query, querySync, querySync, querySync, querySync, querySync, requestStatusSync, resolve, setAddress, setAddress, setAutoSequence, setHandler, setKeyPair, setNextSequence, 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 Connection connection

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

remoteAddress

protected InetSocketAddress remoteAddress

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,
 AStore store)
                      throws IOException,
TimeoutException

Throws:

IOException

TimeoutException

reconnect

public void reconnect()
               throws IOException,
TimeoutException

Throws:

IOException

TimeoutException

setConnection

protected void setConnection(Connection 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

closeButMaintainConnection

public void closeButMaintainConnection()

Close without affecting the underlying connection (will be unlinked but not closed)

acquireState

public CompletableFuture<State> acquireState()
                                      throws TimeoutException

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.

Specified by:

acquireState in class Convex

Returns:

Future for consensus state

Throws:

TimeoutException - If initial status request times out

transact

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

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

Throws:

IOException - If the connection is broken or send buffer is full

query

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

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

Throws:

IOException - In case of IO problem (connection is broken, send buffer full)

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)
                                           throws IOException

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

Throws:

IOException - if the connection fails.

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

Specified by:

getLocalServer in class Convex

Returns:

Server instance (or null)