Interface NostrEventStore

All Known Implementing Classes:

NostrInMemoryEventStore, NostrVStoreEventStore, NostrWeakInMemoryEventStore

public interface NostrEventStore

Stores Nostr events.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	NostrEventStore.Entry	An event and the time it was first received.

Field Summary

Fields

Modifier and Type	Field	Description
static final Comparator<SignedNostrEvent>	ORDER

Method Summary

Modifier and Type	Method	Description
default org.ngengine.platform.AsyncTask<Void>	addEvent(SignedNostrEvent event)
static String	address(SignedNostrEvent event)
default org.ngengine.platform.AsyncTask<Iterator<org.ngengine.nostr4j.store.NostrEventIndex.Metadata>>	candidates(NostrFilter filter, Predicate<org.ngengine.nostr4j.store.NostrEventIndex.Metadata> eligible)	Returns filter candidates from newest to oldest.
org.ngengine.platform.AsyncTask<Void>	clear()	Removes events without deleting metadata or unrelated files.
static org.ngengine.platform.AsyncTask<Void>	collect(Iterator<org.ngengine.nostr4j.store.NostrEventIndex.Metadata> entries, NostrFilter filter, Function<String, org.ngengine.platform.AsyncTask<SignedNostrEvent>> lookup, Map<String, SignedNostrEvent> selected, int count)
default org.ngengine.platform.AsyncTask<Void>	discardEntry(String id)	Removes an event when its contents are not needed.
org.ngengine.platform.AsyncTask<List<String>>	entryIds()
default org.ngengine.platform.AsyncTask<SignedNostrEvent>	get(String id)
default org.ngengine.platform.AsyncTask<List<SignedNostrEvent>>	getEvents(List<NostrFilter> filters)
default org.ngengine.platform.AsyncTask<List<SignedNostrEvent>>	getEvents(List<NostrFilter> filters, List<SignedNostrEvent> results)
default org.ngengine.platform.AsyncTask<List<org.ngengine.nostr4j.store.NostrEventIndex.Metadata>>	maintenanceBatch(String after, int count)	Returns at most count metadata entries after the previous ID, wrapping at the end.
default org.ngengine.platform.AsyncTask<List<SignedNostrEvent>>	query(Collection<NostrFilter> filters)
static org.ngengine.platform.AsyncTask<List<SignedNostrEvent>>	query(NostrEventStore store, Collection<NostrFilter> filters, Function<String, org.ngengine.platform.AsyncTask<SignedNostrEvent>> lookup, Predicate<org.ngengine.nostr4j.store.NostrEventIndex.Metadata> eligible)	Reads only enough matching events to fill each filter's limit.
org.ngengine.platform.AsyncTask<NostrEventStore.Entry>	readEntry(String id)
org.ngengine.platform.AsyncTask<byte[]>	readMetadata(String name)
org.ngengine.platform.AsyncTask<NostrEventStore.Entry>	removeEntry(String id)
default org.ngengine.platform.AsyncTask<Integer>	size()
static <T> org.ngengine.platform.AsyncTask<Void>	visit(List<T> values, Function<T, org.ngengine.platform.AsyncTask<?>> action)
org.ngengine.platform.AsyncTask<Void>	writeEntry(String id, NostrEventStore.Entry entry)	Saves a new event.
org.ngengine.platform.AsyncTask<Void>	writeMetadata(String name, byte[] value)

Field Details

ORDER

static final Comparator<SignedNostrEvent> ORDER

Method Details

readEntry

org.ngengine.platform.AsyncTask<NostrEventStore.Entry> readEntry(String id)

writeEntry

org.ngengine.platform.AsyncTask<Void> writeEntry(String id,
 NostrEventStore.Entry entry)

Saves a new event. Duplicate IDs keep their original receipt time.

removeEntry

org.ngengine.platform.AsyncTask<NostrEventStore.Entry> removeEntry(String id)

discardEntry

default org.ngengine.platform.AsyncTask<Void> discardEntry(String id)

Removes an event when its contents are not needed.

entryIds

org.ngengine.platform.AsyncTask<List<String>> entryIds()

clear

org.ngengine.platform.AsyncTask<Void> clear()

Removes events without deleting metadata or unrelated files.

readMetadata

org.ngengine.platform.AsyncTask<byte[]> readMetadata(String name)

writeMetadata

org.ngengine.platform.AsyncTask<Void> writeMetadata(String name,
 byte[] value)

addEvent

default org.ngengine.platform.AsyncTask<Void> addEvent(SignedNostrEvent event)

get

default org.ngengine.platform.AsyncTask<SignedNostrEvent> get(String id)

size

default org.ngengine.platform.AsyncTask<Integer> size()

getEvents

default org.ngengine.platform.AsyncTask<List<SignedNostrEvent>> getEvents(List<NostrFilter> filters)

getEvents

default org.ngengine.platform.AsyncTask<List<SignedNostrEvent>> getEvents(List<NostrFilter> filters,
 List<SignedNostrEvent> results)

query

default org.ngengine.platform.AsyncTask<List<SignedNostrEvent>> query(Collection<NostrFilter> filters)

candidates

default org.ngengine.platform.AsyncTask<Iterator<org.ngengine.nostr4j.store.NostrEventIndex.Metadata>> candidates(NostrFilter filter,
 Predicate<org.ngengine.nostr4j.store.NostrEventIndex.Metadata> eligible)

Returns filter candidates from newest to oldest.

maintenanceBatch

default org.ngengine.platform.AsyncTask<List<org.ngengine.nostr4j.store.NostrEventIndex.Metadata>> maintenanceBatch(String after,
 int count)

Returns at most count metadata entries after the previous ID, wrapping at the end.

address

static String address(SignedNostrEvent event)

query

static org.ngengine.platform.AsyncTask<List<SignedNostrEvent>> query(NostrEventStore store,
 Collection<NostrFilter> filters,
 Function<String, org.ngengine.platform.AsyncTask<SignedNostrEvent>> lookup,
 Predicate<org.ngengine.nostr4j.store.NostrEventIndex.Metadata> eligible)

Reads only enough matching events to fill each filter's limit.

collect

static org.ngengine.platform.AsyncTask<Void> collect(Iterator<org.ngengine.nostr4j.store.NostrEventIndex.Metadata> entries,
 NostrFilter filter,
 Function<String, org.ngengine.platform.AsyncTask<SignedNostrEvent>> lookup,
 Map<String, SignedNostrEvent> selected,
 int count)

visit

static <T> org.ngengine.platform.AsyncTask<Void> visit(List<T> values,
 Function<T, org.ngengine.platform.AsyncTask<?>> action)