Package convex.api

Class ConvexLocal

java.lang.Object

convex.api.Convex

convex.api.ConvexLocal

public class ConvexLocal
extends Convex

Convex Client implementation supporting a direct connection to a Peer Server in the same JVM.

Field Summary

Fields inherited from class convex.api.Convex

address, awaiting, internalHandler, keyPair, sequence, timeout

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConvexLocal(Server server, 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 remote Peer
void	close()	Disconnects the client from the network, releasing any connection resources.
static ConvexLocal	create(Server server, Address address, AKeyPair keyPair)
long	getSequence()	Gets the current sequence number for this Client, which is the sequence number of the last transaction observed for the current client's Account.
long	getSequence(Address addr)	Gets the current sequence number for an account, which is the sequence number of the last transaction observed for the Account.
boolean	isConnected()	Checks if this Convex client instance has an open 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.
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.
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, connectRemote, createAccount, createAccountSync, finalize, getAccountKey, getAddress, getBalance, isAutoSequence, maybeUpdateSequence, query, query, querySync, querySync, querySync, querySync, querySync, requestStatusSync, setAddress, setAddress, setAutoSequence, setHandler, setKeyPair, setNextSequence, signData, transact, transact, transactSync, transactSync, transactSync, transactSync, transactSync, transfer, transferSync

Methods inherited from class java.lang.Object

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

Constructor Details

ConvexLocal

protected ConvexLocal(Server server,
 Address address,
 AKeyPair keyPair)

Method Details

create

public static ConvexLocal create(Server server,
 Address address,
 AKeyPair keyPair)

isConnected

public boolean isConnected()

Description copied from class: Convex

Checks if this Convex client instance has an open connection.

Specified by:

isConnected in class Convex

Returns:

true if connected, false otherwise

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)

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

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

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

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

close

public void close()

Description copied from class: Convex

Disconnects the client from the network, releasing any connection resources.

Specified by:

close in class Convex

acquireState

public CompletableFuture<State> acquireState()
                                      throws TimeoutException

Description copied from class: Convex

Gets the consensus state from the remote Peer

Specified by:

acquireState in class Convex

Returns:

Future for consensus state

Throws:

TimeoutException - If initial status request times out

getSequence

public long getSequence()

Description copied from class: Convex

Gets the current sequence number for this Client, which is the sequence number of the last transaction observed for the current client's Account. Will attempt to acquire the sequence number from the network if not known. The next valid sequence number will be one higher than the result.

Overrides:

getSequence in class Convex

Returns:

Sequence number as a Long value (zero or positive)

getSequence

public long getSequence(Address addr)

Description copied from class: Convex

Gets the current sequence number for an account, which is the sequence number of the last transaction observed for the Account. Will attempt to acquire the sequence number from the network if not known.

Overrides:

getSequence in class Convex

Parameters:

addr - Address for which to query the sequence number

Returns:

Sequence number as a Long value (zero or positive)