com.radixdlt.client.core.ledger

Interface AtomStore

All Known Implementing Classes:

InMemoryAtomStore

public interface AtomStore

The interface in which a client retrieves the state of the ledger. Particle conflict handling along with Atom DELETEs and STOREs all occur at this layer.

Method Summary

Modifier and Type	Method and Description
io.reactivex.Observable<AtomObservation>	getAtomObservations(RadixAddress address) Retrieve a never ending observable of atom observations (STORED and DELETED) which are then processed by the local store.
java.util.List<ParticleGroup>	getStagedAndClear(java.lang.String uuid) Retrieves all staged particle groups and clears the staging area for the given uuid.
java.util.stream.Stream<Atom>	getStoredAtoms(RadixAddress address) Retrieve the current set of validated atoms at a given shardable
java.util.stream.Stream<Particle>	getUpParticles(RadixAddress address, java.lang.String uuid) Retrieve the current set of validated up particles at a given shardable.
io.reactivex.Observable<java.lang.Long>	onSync(RadixAddress address) Temporary interface for propagating when the current store is synced with some node on a given address.
void	stageParticleGroup(java.lang.String uuid, ParticleGroup particleGroup) Adds the particle group to the staging area for the given uuid

Method Detail

onSync

io.reactivex.Observable<java.lang.Long> onSync(RadixAddress address)

Temporary interface for propagating when the current store is synced with some node on a given address. TODO: This is probably the wrong place for this and will probably TODO: move this into a different layer but good enough for now

Parameters:

address - The address to check for sync

Returns:

a never ending observable which emits when local store is synced with some origin

getStoredAtoms

java.util.stream.Stream<Atom> getStoredAtoms(RadixAddress address)

Retrieve the current set of validated atoms at a given shardable

Parameters:

address - the address to get the atoms under

Returns:

a stream of all stored atoms of the current local view

getAtomObservations

io.reactivex.Observable<AtomObservation> getAtomObservations(RadixAddress address)

Retrieve a never ending observable of atom observations (STORED and DELETED) which are then processed by the local store.

Parameters:

address - the address to get the updates from

Returns:

a never ending observable of updates

getUpParticles

java.util.stream.Stream<Particle> getUpParticles(RadixAddress address,
                                                 @Nullable
                                                 java.lang.String uuid)

Retrieve the current set of validated up particles at a given shardable. If uuid is provided also retrieves and staged particles under that uuid.

Parameters:

address - the address to get the particles under

uuid - uuid of staged particles to include

Returns:

a stream of all up particles of the current local view

stageParticleGroup

void stageParticleGroup(java.lang.String uuid,
                        ParticleGroup particleGroup)

Adds the particle group to the staging area for the given uuid

Parameters:

uuid - the uuid to add the particle group to

particleGroup - the particle group to add to staging area

getStagedAndClear

java.util.List<ParticleGroup> getStagedAndClear(java.lang.String uuid)

Retrieves all staged particle groups and clears the staging area for the given uuid. TODO: Cleanup interface

Parameters:

uuid - uuid to retrieve the staged particle groups for

Returns:

all staged particle groups in the order they were staged