Index (Parsley 0.3.0-SNAPSHOT API)

A B C D E F G H I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

accept(byte[], byte[]) - Method in interface io.github.tobyjamesclements.parsley.core.OrderingStore.EntryConsumer: Receives one entry.
ACCEPTED - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ProcessEngine.ReceiveOutcome: Taken into the hold-back buffer, or immediately deliverable.
APPLICATION_PAYLOAD_UNDECODABLE - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: An application payload could not be decoded by its declared serde.
APPLICATION_PAYLOAD_UNSERIALIZABLE - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: An application payload could not be serialized by its declared serde.
applicationIdPrefix() - Method in class io.github.tobyjamesclements.parsley.api.ParsleyConfig: Returns the prefix for each process's application id.
awaitStopped() - Method in class io.github.tobyjamesclements.parsley.api.Parsley: Waits until a process stops, or this handle is closed.
awaitStopped() - Method in class io.github.tobyjamesclements.parsley.kafka.ParsleyRuntime: Waits until any process stops or this runtime closes.
awaitStopped(Duration) - Method in class io.github.tobyjamesclements.parsley.api.Parsley: Waits, for at most timeout, until a process stops or this handle is closed.
awaitStopped(Duration) - Method in class io.github.tobyjamesclements.parsley.kafka.ParsleyRuntime: Waits, bounded, until any process stops or this runtime closes.

B

Blocker(ChannelId, long, OptionalLong) - Constructor for record class io.github.tobyjamesclements.parsley.core.Deliverability.Blocker: Creates an instance of a Blocker record class.
Blocker(String, int, long, OptionalLong) - Constructor for record class io.github.tobyjamesclements.parsley.api.TaskStatus.Blocker: Refuses null components.
blockers() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus.HeldChannel: Returns the value of the blockers record component.
blockers() - Method in record class io.github.tobyjamesclements.parsley.core.Deliverability.Held: Returns the value of the blockers record component.
bootstrapServers() - Method in class io.github.tobyjamesclements.parsley.api.ParsleyConfig: Returns the Kafka bootstrap servers.
build() - Method in class io.github.tobyjamesclements.parsley.api.Effects.Builder: Returns the accumulated effects.
build() - Method in class io.github.tobyjamesclements.parsley.api.ParsleyConfig.Builder: Returns the configuration.
build() - Method in class io.github.tobyjamesclements.parsley.api.ProcessDefinition.Builder: Builds the definition.
builder() - Static method in class io.github.tobyjamesclements.parsley.api.Effects: Returns a new builder.
builder(String, String) - Static method in class io.github.tobyjamesclements.parsley.api.ParsleyConfig: Begins a configuration.
byChannel() - Method in class io.github.tobyjamesclements.parsley.core.Causes: Returns the frontier as an unmodifiable map in ChannelId order.

C

CausalPast - Class in io.github.tobyjamesclements.parsley.session: A causal past carried at the edge of the pipeline: a session token held by a client, or the recorded past stored beside a projected row.
CausalPast.Coverage - Record Class in io.github.tobyjamesclements.parsley.session: The outcome of one coverage check.
causes() - Method in record class io.github.tobyjamesclements.parsley.core.DeliverableMessage: Returns the value of the causes record component.
causes() - Method in class io.github.tobyjamesclements.parsley.session.CausalPast: Returns the frontier this past carries.
causes(Map) - Static method in class io.github.tobyjamesclements.parsley.core.CausesCodec: Builds a frontier from a plain map.
Causes - Class in io.github.tobyjamesclements.parsley.core: A causal frontier: per channel, the highest position known to be a cause.
CausesCodec - Class in io.github.tobyjamesclements.parsley.core: The wire representation of a causal frontier.
CausesCodec.UndecodableMetadataException - Exception Class in io.github.tobyjamesclements.parsley.core: Signals metadata that was present and could not be trusted.
causesHeaderForEmission() - Method in class io.github.tobyjamesclements.parsley.core.ProcessEngine: The metadata every message sent by this step must carry.
channel() - Method in class io.github.tobyjamesclements.parsley.api.Delivery: Returns the channel this message arrived on.
channel() - Method in record class io.github.tobyjamesclements.parsley.api.Effects.Emission: Returns the value of the channel record component.
channel() - Method in record class io.github.tobyjamesclements.parsley.api.ProcessDefinition.Input: Returns the value of the channel record component.
channel() - Method in record class io.github.tobyjamesclements.parsley.core.Deliverability.Blocker: Returns the value of the channel record component.
channel() - Method in record class io.github.tobyjamesclements.parsley.core.DeliverableMessage: Returns the value of the channel record component.
channel() - Method in record class io.github.tobyjamesclements.parsley.core.ReceivedMessage: Returns the value of the channel record component.
Channel<K,V> - Class in io.github.tobyjamesclements.parsley.api: A typed topic a process receives from or sends to.
CHANNEL_DELETED_WITH_UNDELIVERED_MESSAGES - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: A received topic was deleted while messages from it remained undelivered.
CHANNEL_IDENTITY_CHANGED - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: A topic was recreated, so positions held against the old identity are meaningless.
CHANNEL_REMOVED_WITH_HELD_MESSAGES - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: A channel left the received set while it still held undelivered messages.
Channel.InitialPosition - Enum Class in io.github.tobyjamesclements.parsley.api: Where a process begins reading a channel it has no committed position for.
ChannelId - Record Class in io.github.tobyjamesclements.parsley.core: A channel, named by topic identity rather than topic name.
ChannelId(UUID, int) - Constructor for record class io.github.tobyjamesclements.parsley.core.ChannelId: Validates the topic identity and partition.
close() - Method in class io.github.tobyjamesclements.parsley.api.Parsley: Stops every process and releases its resources.
close() - Method in class io.github.tobyjamesclements.parsley.kafka.ParsleyRuntime: Closes every process and releases every resource.
compareTo(ChannelId) - Method in record class io.github.tobyjamesclements.parsley.core.ChannelId: Orders by topic identity unsigned, then by partition.
Coverage(List) - Constructor for record class io.github.tobyjamesclements.parsley.session.CausalPast.Coverage: Copies the gaps.
coverageOf(CausalPast) - Method in class io.github.tobyjamesclements.parsley.session.CausalPast: Decides whether this past covers a token: whether everything the token names is at or below what this past records.
COVERED_POSITION_FED - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: The host fed a channel at a position, above the session floor, that this execution's own coverage already records as fed or never arriving: the feed and the engine's record contradict each other.
coveredPositions(Map) - Static method in class io.github.tobyjamesclements.parsley.core.OrderingStateInspector
covers() - Method in record class io.github.tobyjamesclements.parsley.session.CausalPast.Coverage: Returns true when the past accounts for everything the token names.

D

deadChannels() - Method in record class io.github.tobyjamesclements.parsley.core.IdentityReport: Returns the value of the deadChannels record component.
decide(Causes, Set, Deliverability.SettledView) - Static method in class io.github.tobyjamesclements.parsley.core.Deliverability: Decides whether a message expressing causes may be delivered.
decode(byte[]) - Static method in class io.github.tobyjamesclements.parsley.core.CausesCodec: Decodes a frontier.
decode(byte[]) - Static method in class io.github.tobyjamesclements.parsley.session.CausalPast: Decodes a past from the frozen wire grammar, exactly as strictly as the engine decodes a parsley.causes header.
DEFAULT_METADATA_BUDGET_BYTES - Static variable in class io.github.tobyjamesclements.parsley.core.ProcessEngine: Metadata budget applied where a configuration names none.
delete(byte[]) - Method in interface io.github.tobyjamesclements.parsley.core.OrderingStore: Removes one entry.
delete(Store, K) - Method in class io.github.tobyjamesclements.parsley.api.Effects.Builder: Removes a key.
Deliverability - Class in io.github.tobyjamesclements.parsley.core: The delivery decision, as a pure function.
Deliverability.Blocker - Record Class in io.github.tobyjamesclements.parsley.core: One unsatisfied cause.
Deliverability.Deliverable - Class in io.github.tobyjamesclements.parsley.core: Every cause is satisfied.
Deliverability.Held - Record Class in io.github.tobyjamesclements.parsley.core: At least one cause is outstanding.
Deliverability.SettledView - Interface in io.github.tobyjamesclements.parsley.core: Per-channel view of how far delivery has settled.
Deliverability.Verdict - Interface in io.github.tobyjamesclements.parsley.core: The outcome of one decision.
DeliverableMessage - Record Class in io.github.tobyjamesclements.parsley.core: A message the engine has established as deliverable, with its causes decoded.
DeliverableMessage(ChannelId, long, long, byte[], byte[], List, Causes) - Constructor for record class io.github.tobyjamesclements.parsley.core.DeliverableMessage: Creates an instance of a DeliverableMessage record class.
Delivery<K,V> - Class in io.github.tobyjamesclements.parsley.api: One message, established as causally deliverable and handed to application logic.
DUPLICATE_DROPPED - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ProcessEngine.ReceiveOutcome: Already delivered in a previous execution, so ignored.

E

EARLIEST - Enum constant in enum class io.github.tobyjamesclements.parsley.api.Channel.InitialPosition: Begin at the earliest retained message.
Effects - Class in io.github.tobyjamesclements.parsley.api: Everything one step changes: the messages it sends and the state it writes.
Effects.Builder - Class in io.github.tobyjamesclements.parsley.api: Accumulates sends and writes.
Effects.Emission<K,V> - Record Class in io.github.tobyjamesclements.parsley.api: One message to send.
Effects.StateWrite<K,V> - Record Class in io.github.tobyjamesclements.parsley.api: One change to application state.
Emission(Channel, K, V, List) - Constructor for record class io.github.tobyjamesclements.parsley.api.Effects.Emission: An emission inheriting the delivered message's timestamp.
Emission(Channel, K, V, List, OptionalLong) - Constructor for record class io.github.tobyjamesclements.parsley.api.Effects.Emission: Copies the headers and rejects any using the reserved prefix.
EMISSION_TO_UNDECLARED_CHANNEL - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: A handler emitted on a channel its process never declared.
emissions() - Method in class io.github.tobyjamesclements.parsley.api.Effects: Returns the messages to send, in declaration order.
encode() - Method in class io.github.tobyjamesclements.parsley.session.CausalPast: Encodes this past in the frozen wire grammar.
encode(Causes) - Static method in class io.github.tobyjamesclements.parsley.core.CausesCodec: Encodes a frontier.
ENCODED_LENGTH - Static variable in record class io.github.tobyjamesclements.parsley.core.ChannelId: Encoded width in bytes: two longs of topic identity, then the partition.
equals(Object) - Method in record class io.github.tobyjamesclements.parsley.api.Effects.Emission: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.tobyjamesclements.parsley.api.Effects.StateWrite: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.tobyjamesclements.parsley.api.ProcessDefinition.Input: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.tobyjamesclements.parsley.api.ProcessStatus: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus.Blocker: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus.HeldChannel: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class io.github.tobyjamesclements.parsley.core.Causes
equals(Object) - Method in record class io.github.tobyjamesclements.parsley.core.ChannelId: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.tobyjamesclements.parsley.core.Deliverability.Blocker: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.tobyjamesclements.parsley.core.Deliverability.Held: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.tobyjamesclements.parsley.core.DeliverableMessage: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.tobyjamesclements.parsley.core.HeaderKV: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.tobyjamesclements.parsley.core.IdentityReport: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.tobyjamesclements.parsley.core.ReceivedMessage: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.tobyjamesclements.parsley.session.CausalPast.Coverage: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class io.github.tobyjamesclements.parsley.session.CausalPast
extraProperties() - Method in class io.github.tobyjamesclements.parsley.api.ParsleyConfig: Returns additional Kafka Streams properties, none of them safety-bearing.

F

failureDetail() - Method in record class io.github.tobyjamesclements.parsley.api.ProcessStatus: Returns the value of the failureDetail record component.
fedUpTo(ChannelId) - Method in class io.github.tobyjamesclements.parsley.core.ProcessEngine: Reports how far one channel has been fed.
findIn(Throwable) - Static method in exception class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException: Searches a failure's cause chain for a fail-closed diagnosis.
flushHolds() - Method in class io.github.tobyjamesclements.parsley.core.ProcessEngine: Persists every held message not yet written.
FORMAT_VERSION - Static variable in class io.github.tobyjamesclements.parsley.core.CausesCodec: Version byte leading every encoded frontier.
frontierBytes() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus: Returns the value of the frontierBytes record component.
frontierBytes() - Method in class io.github.tobyjamesclements.parsley.core.ProcessEngine: Returns the encoded width of the frontier, in bytes.
frontierChannels() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus: Returns the value of the frontierChannels record component.
frontierSize() - Method in class io.github.tobyjamesclements.parsley.core.ProcessEngine: Returns how many channels the frontier names.
frontierSnapshot() - Method in class io.github.tobyjamesclements.parsley.core.ProcessEngine: Returns the frontier as it stands, for diagnostics and tests.

G

gaps() - Method in record class io.github.tobyjamesclements.parsley.session.CausalPast.Coverage: Returns the value of the gaps record component.
get(byte[]) - Method in interface io.github.tobyjamesclements.parsley.core.OrderingStore: Reads one entry.
get(Store, K) - Method in interface io.github.tobyjamesclements.parsley.api.StateReader: Reads one value.

H

handle(Delivery, StateReader) - Method in interface io.github.tobyjamesclements.parsley.api.Handler: Computes the effects of one delivery.
handler() - Method in record class io.github.tobyjamesclements.parsley.api.ProcessDefinition.Input: Returns the value of the handler record component.
Handler<K,V> - Interface in io.github.tobyjamesclements.parsley.api: Application logic for one channel of one process.
HANDLER_RETURNED_NULL_EFFECTS - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: A handler returned null where its effects were required.
hashCode() - Method in record class io.github.tobyjamesclements.parsley.api.Effects.Emission: Returns a hash code value for this object.
hashCode() - Method in record class io.github.tobyjamesclements.parsley.api.Effects.StateWrite: Returns a hash code value for this object.
hashCode() - Method in record class io.github.tobyjamesclements.parsley.api.ProcessDefinition.Input: Returns a hash code value for this object.
hashCode() - Method in record class io.github.tobyjamesclements.parsley.api.ProcessStatus: Returns a hash code value for this object.
hashCode() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus.Blocker: Returns a hash code value for this object.
hashCode() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus: Returns a hash code value for this object.
hashCode() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus.HeldChannel: Returns a hash code value for this object.
hashCode() - Method in class io.github.tobyjamesclements.parsley.core.Causes: Returns a hash consistent with Causes.equals(Object).
hashCode() - Method in record class io.github.tobyjamesclements.parsley.core.ChannelId: Returns a hash code value for this object.
hashCode() - Method in record class io.github.tobyjamesclements.parsley.core.Deliverability.Blocker: Returns a hash code value for this object.
hashCode() - Method in record class io.github.tobyjamesclements.parsley.core.Deliverability.Held: Returns a hash code value for this object.
hashCode() - Method in record class io.github.tobyjamesclements.parsley.core.DeliverableMessage: Returns a hash code value for this object.
hashCode() - Method in record class io.github.tobyjamesclements.parsley.core.HeaderKV: Returns a hash code value for this object.
hashCode() - Method in record class io.github.tobyjamesclements.parsley.core.IdentityReport: Returns a hash code value for this object.
hashCode() - Method in record class io.github.tobyjamesclements.parsley.core.ReceivedMessage: Returns a hash code value for this object.
hashCode() - Method in record class io.github.tobyjamesclements.parsley.session.CausalPast.Coverage: Returns a hash code value for this object.
hashCode() - Method in class io.github.tobyjamesclements.parsley.session.CausalPast: Returns a hash consistent with CausalPast.equals(Object).
HEADER_KEY - Static variable in class io.github.tobyjamesclements.parsley.core.CausesCodec: The header carrying the encoded frontier.
HeaderKV - Record Class in io.github.tobyjamesclements.parsley.core: One message header.
HeaderKV(String, byte[]) - Constructor for record class io.github.tobyjamesclements.parsley.core.HeaderKV: Validates the header name.
headers() - Method in class io.github.tobyjamesclements.parsley.api.Delivery: Returns the application's own headers, with reserved entries removed.
headers() - Method in record class io.github.tobyjamesclements.parsley.api.Effects.Emission: Returns the value of the headers record component.
headers() - Method in record class io.github.tobyjamesclements.parsley.core.DeliverableMessage: Returns the value of the headers record component.
headers() - Method in record class io.github.tobyjamesclements.parsley.core.ReceivedMessage: Returns the value of the headers record component.
headPosition() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus.HeldChannel: Returns the value of the headPosition record component.
headPosition(ChannelId) - Method in class io.github.tobyjamesclements.parsley.core.ProcessEngine: Reports the position of the oldest held message on a channel, the one the decision reads.
headVerdict(ChannelId) - Method in class io.github.tobyjamesclements.parsley.core.ProcessEngine: Reports the decision for the oldest held message on a channel, as diagnosis: the same verdict ProcessEngine.nextDeliverable() would act on, with every outstanding cause named when it is held.
healthy() - Method in class io.github.tobyjamesclements.parsley.api.Parsley: Reports whether every process is still running.
healthy() - Method in class io.github.tobyjamesclements.parsley.kafka.ParsleyRuntime: Returns true while every process is running or rebalancing.
held() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus.HeldChannel: Returns the value of the held record component.
Held(List) - Constructor for record class io.github.tobyjamesclements.parsley.core.Deliverability.Held: Creates an instance of a Held record class.
HeldChannel(String, int, int, long, List) - Constructor for record class io.github.tobyjamesclements.parsley.api.TaskStatus.HeldChannel: Copies the blockers and refuses null components.
heldChannels() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus: Returns the value of the heldChannels record component.
heldChannels(Map) - Static method in class io.github.tobyjamesclements.parsley.core.OrderingStateInspector: Finds the channels holding undelivered messages.
heldCount(ChannelId) - Method in class io.github.tobyjamesclements.parsley.core.ProcessEngine: Reports the depth of one channel's hold-back buffer.
heldCountTotal() - Method in class io.github.tobyjamesclements.parsley.core.ProcessEngine: Returns how many messages are held across every channel.
heldMessages() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus: Returns the value of the heldMessages record component.

I

identityChangedTopics(Map, Map) - Static method in class io.github.tobyjamesclements.parsley.core.OrderingStateInspector: Finds topics that now resolve to a different identity than the one recorded.
IdentityReport - Record Class in io.github.tobyjamesclements.parsley.core: What a host learned of channel identity when a process initialised: which channels' topics no longer exist, and which exist again under a new identity.
IdentityReport(Set, Set) - Constructor for record class io.github.tobyjamesclements.parsley.core.IdentityReport: Defensively copies both sets.
initialPosition() - Method in class io.github.tobyjamesclements.parsley.api.Channel: Returns where reading begins when no committed position exists.
input(String) - Method in class io.github.tobyjamesclements.parsley.api.ProcessDefinition: Looks up a received channel.
Input(Channel, Handler) - Constructor for record class io.github.tobyjamesclements.parsley.api.ProcessDefinition.Input: Creates an instance of a Input record class.
io.github.tobyjamesclements.parsley.api - package io.github.tobyjamesclements.parsley.api: The declaration surface: what an application writes.
io.github.tobyjamesclements.parsley.core - package io.github.tobyjamesclements.parsley.core: The protocol, independent of any host.
io.github.tobyjamesclements.parsley.kafka - package io.github.tobyjamesclements.parsley.kafka: The Kafka Streams adapter.
io.github.tobyjamesclements.parsley.session - package io.github.tobyjamesclements.parsley.session: Session consistency at the edge: the companion surface for carrying a causal past beyond the last consumer.
isDeliverable() - Method in class io.github.tobyjamesclements.parsley.core.Deliverability.Deliverable: Returns true.
isDeliverable() - Method in record class io.github.tobyjamesclements.parsley.core.Deliverability.Held: Returns false.
isDeliverable() - Method in interface io.github.tobyjamesclements.parsley.core.Deliverability.Verdict: Returns true when the message may be delivered now.
isEmpty() - Method in class io.github.tobyjamesclements.parsley.core.Causes: Returns true when this frontier names no channel.
isEmpty() - Method in class io.github.tobyjamesclements.parsley.session.CausalPast: Returns true when this past names no channel.
isFedToEnd(long) - Static method in class io.github.tobyjamesclements.parsley.core.OrderingStateInspector: Whether a covered position is the engine's fed-to-end sentinel: the value a channel settled on its topic's confirmed deletion carries, which no offset can follow.
isHeldKey(byte[]) - Static method in class io.github.tobyjamesclements.parsley.core.OrderingStateInspector: Whether a key is a held message's, by its tag and shape.
isValidTopicName(String) - Static method in class io.github.tobyjamesclements.parsley.api.KafkaNames: Decides whether a name satisfies Kafka's topic-name rule.

K

KafkaNames - Class in io.github.tobyjamesclements.parsley.api: The one spelling of Kafka's topic-name rule.
key() - Method in class io.github.tobyjamesclements.parsley.api.Delivery: Returns the message key.
key() - Method in record class io.github.tobyjamesclements.parsley.api.Effects.Emission: Returns the value of the key record component.
key() - Method in record class io.github.tobyjamesclements.parsley.api.Effects.StateWrite: Returns the value of the key record component.
key() - Method in record class io.github.tobyjamesclements.parsley.core.DeliverableMessage: Returns the value of the key record component.
key() - Method in record class io.github.tobyjamesclements.parsley.core.HeaderKV: Returns the value of the key record component.
key() - Method in record class io.github.tobyjamesclements.parsley.core.ReceivedMessage: Returns the value of the key record component.
keySerde() - Method in class io.github.tobyjamesclements.parsley.api.Channel: Returns the serde for keys.
keySerde() - Method in class io.github.tobyjamesclements.parsley.api.Store: Returns the serde for keys.

L

LATEST - Enum constant in enum class io.github.tobyjamesclements.parsley.api.Channel.InitialPosition: Begin at the end, skipping messages already retained.

M

markDelivered(ChannelId, long) - Method in class io.github.tobyjamesclements.parsley.core.ProcessEngine: Records that a message offered by ProcessEngine.nextDeliverable() was delivered.
MAX_TOPIC_NAME_LENGTH - Static variable in class io.github.tobyjamesclements.parsley.api.KafkaNames: Kafka's topic-name length limit.
merge(ChannelId, long) - Method in class io.github.tobyjamesclements.parsley.session.CausalPast: Merges one observed coordinate: the delivered message's own (channel, position) at a projector's seam, or the coordinate a produce acknowledgement confirmed at a write tier.
merge(CausalPast) - Method in class io.github.tobyjamesclements.parsley.session.CausalPast: Merges another past pointwise: per channel, the greater position wins.
METADATA_BUDGET_EXCEEDED - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: Causal metadata exceeded the configured budget.
metadataBudgetBytes() - Method in class io.github.tobyjamesclements.parsley.api.ParsleyConfig: Returns the largest causal metadata a message may carry, in bytes.
metadataBudgetBytes(int) - Method in class io.github.tobyjamesclements.parsley.api.ParsleyConfig.Builder: Sets the largest causal metadata a message may carry.

N

name() - Method in class io.github.tobyjamesclements.parsley.api.ProcessDefinition: Returns the process name.
name() - Method in class io.github.tobyjamesclements.parsley.api.Store: Returns the store name.
nameBindings(Map) - Static method in class io.github.tobyjamesclements.parsley.core.OrderingStateInspector: Recovers which topic identity each topic name was bound to.
named(String) - Static method in class io.github.tobyjamesclements.parsley.api.ProcessDefinition: Begins a definition.
nextDeliverable() - Method in class io.github.tobyjamesclements.parsley.core.ProcessEngine: Offers the next message whose causes are all satisfied.
none() - Static method in class io.github.tobyjamesclements.parsley.api.Effects: The empty result, for a step that observes without changing anything.
none() - Static method in class io.github.tobyjamesclements.parsley.core.Causes: The empty frontier, expressed by a message with no causes.
none() - Static method in class io.github.tobyjamesclements.parsley.session.CausalPast: The empty past: a session that has observed nothing.
NONE - Static variable in record class io.github.tobyjamesclements.parsley.core.IdentityReport: Nothing gone and nothing recreated: every channel still is what it was.

O

of(Channel, int, long, long, K, V, List) - Static method in class io.github.tobyjamesclements.parsley.api.Delivery: Builds a delivery.
of(Causes) - Static method in class io.github.tobyjamesclements.parsley.session.CausalPast: Builds a past over an existing frontier.
of(String, Serde, Serde) - Static method in class io.github.tobyjamesclements.parsley.api.Channel: Defines a channel starting at Channel.InitialPosition.EARLIEST.
of(String, Serde, Serde) - Static method in class io.github.tobyjamesclements.parsley.api.Store: Defines a store.
of(Map) - Static method in class io.github.tobyjamesclements.parsley.core.Causes: Builds a frontier.
onIdentityReport(IdentityReport) - Method in class io.github.tobyjamesclements.parsley.core.ProcessEngine: Takes what the host learned of channel identity when it initialised this process.
onReceive(ReceivedMessage) - Method in class io.github.tobyjamesclements.parsley.core.ProcessEngine: Takes one message from the host.
ORDERING_STATE_LOST - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: Committed read positions exist for this process while the ordering state a prior execution must have written alongside them is gone.
OrderingStateInspector - Class in io.github.tobyjamesclements.parsley.core: Reads ordering state without an engine.
OrderingStore - Interface in io.github.tobyjamesclements.parsley.core: The byte-level key-value store holding a process's ordering state.
OrderingStore.EntryConsumer - Interface in io.github.tobyjamesclements.parsley.core: Receives one entry during a prefix scan.
OUT_OF_ORDER_FEED - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: The host fed a channel out of position order.

P

Parsley - Class in io.github.tobyjamesclements.parsley.api: A running set of processes, each executing under causal delivery order.
ParsleyConfig - Class in io.github.tobyjamesclements.parsley.api: Broker connection, application identity and the tuning Parsley leaves open.
ParsleyConfig.Builder - Class in io.github.tobyjamesclements.parsley.api: Accumulates configuration, rejecting anything that would weaken the guarantee.
ParsleyFailClosedException - Exception Class in io.github.tobyjamesclements.parsley.core: Thrown where the delivery guarantee cannot be upheld.
ParsleyFailClosedException(ParsleyFailClosedException.Reason, String) - Constructor for exception class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException: Builds a diagnosis.
ParsleyFailClosedException(ParsleyFailClosedException.Reason, String, Throwable) - Constructor for exception class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException: Builds a diagnosis wrapping an underlying failure.
ParsleyFailClosedException.Reason - Enum Class in io.github.tobyjamesclements.parsley.core: Why delivery stopped.
ParsleyRuntime - Class in io.github.tobyjamesclements.parsley.kafka: Owns the Kafka Streams application behind each running process.
partition() - Method in class io.github.tobyjamesclements.parsley.api.Delivery: Returns the partition within the channel.
partition() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus.Blocker: Returns the value of the partition record component.
partition() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus.HeldChannel: Returns the value of the partition record component.
partition() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus: Returns the value of the partition record component.
partition() - Method in record class io.github.tobyjamesclements.parsley.core.ChannelId: Returns the value of the partition record component.
position() - Method in class io.github.tobyjamesclements.parsley.api.Delivery: Returns the offset of this message within its partition.
position() - Method in record class io.github.tobyjamesclements.parsley.core.DeliverableMessage: Returns the value of the position record component.
position() - Method in record class io.github.tobyjamesclements.parsley.core.ReceivedMessage: Returns the value of the position record component.
POSITIONS_DISCARDED_UNREAD - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: Positions were discarded by retention before this process read them.
process() - Method in record class io.github.tobyjamesclements.parsley.api.ProcessStatus: Returns the value of the process record component.
ProcessDefinition - Class in io.github.tobyjamesclements.parsley.api: One process: the channels it receives, the channels it sends on, and the stores it owns.
ProcessDefinition.Builder - Class in io.github.tobyjamesclements.parsley.api: Accumulates the channels and stores of one process.
ProcessDefinition.Input<K,V> - Record Class in io.github.tobyjamesclements.parsley.api: A received channel and the logic that handles it.
ProcessEngine - Class in io.github.tobyjamesclements.parsley.core: The protocol, driven by a host.
ProcessEngine(String, Map, OrderingStore) - Constructor for class io.github.tobyjamesclements.parsley.core.ProcessEngine: Builds an engine with the default metadata budget and no start positions.
ProcessEngine(String, Map, OrderingStore, int) - Constructor for class io.github.tobyjamesclements.parsley.core.ProcessEngine: Builds an engine with an explicit metadata budget and no start positions.
ProcessEngine(String, Map, OrderingStore, int, Map) - Constructor for class io.github.tobyjamesclements.parsley.core.ProcessEngine: Builds an engine with an explicit metadata budget and the positions the host feeds from.
ProcessEngine.ReceiveOutcome - Enum Class in io.github.tobyjamesclements.parsley.core: What became of a message the host fed in.
ProcessStatus - Record Class in io.github.tobyjamesclements.parsley.api: The state of one process at a moment in time.
ProcessStatus(String, ProcessStatus.State, Optional, Optional) - Constructor for record class io.github.tobyjamesclements.parsley.api.ProcessStatus: A status with no task detail, as reported before any task has initialised.
ProcessStatus(String, ProcessStatus.State, Optional, Optional, List) - Constructor for record class io.github.tobyjamesclements.parsley.api.ProcessStatus: Copies the tasks.
ProcessStatus.State - Enum Class in io.github.tobyjamesclements.parsley.api: Lifecycle state of a process.
put(byte[], byte[]) - Method in interface io.github.tobyjamesclements.parsley.core.OrderingStore: Writes one entry.
put(Store, K, V) - Method in class io.github.tobyjamesclements.parsley.api.Effects.Builder: Writes a value.

R

readFrom(ByteBuffer) - Static method in record class io.github.tobyjamesclements.parsley.core.ChannelId: Reads one channel from a buffer.
reason() - Method in exception class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException: Returns why delivery stopped.
REBALANCING - Enum constant in enum class io.github.tobyjamesclements.parsley.api.ProcessStatus.State: Partition assignment is in flux; delivery resumes when it settles.
receivedChannelSet() - Method in class io.github.tobyjamesclements.parsley.core.ProcessEngine: Returns the channels this process receives, in ChannelId order.
ReceivedMessage - Record Class in io.github.tobyjamesclements.parsley.core: A message as the host fed it to the engine, before its causes were read.
ReceivedMessage(ChannelId, long, long, byte[], byte[], List) - Constructor for record class io.github.tobyjamesclements.parsley.core.ReceivedMessage: Validates the position and copies the headers.
receivedTopics() - Method in class io.github.tobyjamesclements.parsley.api.ProcessDefinition: Returns the topics this process receives, in declaration order.
receives(Channel, Handler) - Method in class io.github.tobyjamesclements.parsley.api.ProcessDefinition.Builder: Receives a channel, handling each delivery with handler.
recreatedChannels() - Method in record class io.github.tobyjamesclements.parsley.core.IdentityReport: Returns the value of the recreatedChannels record component.
refusalReason() - Method in record class io.github.tobyjamesclements.parsley.api.ProcessStatus: Returns the value of the refusalReason record component.
requiredPosition() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus.Blocker: Returns the value of the requiredPosition record component.
requiredPosition() - Method in record class io.github.tobyjamesclements.parsley.core.Deliverability.Blocker: Returns the value of the requiredPosition record component.
RESERVED_HEADER_PREFIX - Static variable in class io.github.tobyjamesclements.parsley.core.CausesCodec: Header prefix reserved for Parsley, which application headers may not use.
RESERVED_HEADER_USED - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: An application header used the prefix reserved for causal metadata.
RESERVED_PREFIX - Static variable in class io.github.tobyjamesclements.parsley.api.Store: Namespace Parsley reserves for its own stores and topics; application names may not contain it.
RUNNING - Enum constant in enum class io.github.tobyjamesclements.parsley.api.ProcessStatus.State: Delivering, or waiting for causes to arrive.

S

scanPrefix(byte[], OrderingStore.EntryConsumer) - Method in interface io.github.tobyjamesclements.parsley.core.OrderingStore: Visits every entry whose key begins with prefix, in unsigned lexicographic key order.
send(Channel, K, V) - Method in class io.github.tobyjamesclements.parsley.api.Effects.Builder: Sends a message with no application headers.
send(Channel, K, V, long) - Method in class io.github.tobyjamesclements.parsley.api.Effects.Builder: Sends a message with its own timestamp, in place of the delivered message's.
send(Channel, K, V, List) - Method in class io.github.tobyjamesclements.parsley.api.Effects.Builder: Sends a message carrying application headers.
send(Channel, K, V, List, long) - Method in class io.github.tobyjamesclements.parsley.api.Effects.Builder: Sends a message with application headers and its own timestamp.
sendChannel(String) - Method in class io.github.tobyjamesclements.parsley.api.ProcessDefinition: Looks up a sent channel.
sends(Channel...) - Method in class io.github.tobyjamesclements.parsley.api.ProcessDefinition.Builder: Declares the channels this process may send on.
sendTopics() - Method in class io.github.tobyjamesclements.parsley.api.ProcessDefinition: Returns the topics this process may send on, in declaration order.
settled(ChannelId) - Method in interface io.github.tobyjamesclements.parsley.core.Deliverability.SettledView: Reports how far one channel has settled.
settledPosition() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus.Blocker: Returns the value of the settledPosition record component.
settledPosition() - Method in record class io.github.tobyjamesclements.parsley.core.Deliverability.Blocker: Returns the value of the settledPosition record component.
settledView() - Method in class io.github.tobyjamesclements.parsley.core.ProcessEngine: Exposes settled positions to the delivery decision.
size() - Method in class io.github.tobyjamesclements.parsley.core.Causes: Returns how many channels this frontier names.
size() - Method in class io.github.tobyjamesclements.parsley.session.CausalPast: Returns how many channels this past names.
start(ParsleyConfig, ProcessDefinition...) - Static method in class io.github.tobyjamesclements.parsley.api.Parsley: Validates every definition, resolves every received and sent topic, establishes each process's initial read positions, then starts every process and returns.
start(ParsleyConfig, List) - Static method in class io.github.tobyjamesclements.parsley.kafka.ParsleyRuntime: Resolves topics, builds a topology per process, and starts each one.
startingAt(Channel.InitialPosition) - Method in class io.github.tobyjamesclements.parsley.api.Channel: Returns a copy of this channel with a different starting position.
state() - Method in record class io.github.tobyjamesclements.parsley.api.ProcessStatus: Returns the value of the state record component.
STATE_ACCESS_TO_UNDECLARED_STORE - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: Application logic read or wrote a store its process never declared.
stateDir() - Method in class io.github.tobyjamesclements.parsley.api.ParsleyConfig: Returns the local state directory, or null for the Kafka Streams default.
stateDir(String) - Method in class io.github.tobyjamesclements.parsley.api.ParsleyConfig.Builder: Sets the local directory holding process state.
StateReader - Interface in io.github.tobyjamesclements.parsley.api: Read access to the stores a process declared.
StateWrite(Store, K, V) - Constructor for record class io.github.tobyjamesclements.parsley.api.Effects.StateWrite: Creates an instance of a StateWrite record class.
status() - Method in class io.github.tobyjamesclements.parsley.api.Parsley: Reports the current state of each process, keyed by process name.
status() - Method in class io.github.tobyjamesclements.parsley.kafka.ParsleyRuntime: Reports the state of every process.
statusInterval() - Method in class io.github.tobyjamesclements.parsley.api.ParsleyConfig: Returns how often each task publishes its delivery state for Parsley.status().
statusInterval(Duration) - Method in class io.github.tobyjamesclements.parsley.api.ParsleyConfig.Builder: Sets how often each task publishes its delivery state for Parsley.status().
STOPPED - Enum constant in enum class io.github.tobyjamesclements.parsley.api.ProcessStatus.State: No longer delivering.
stoppedDeliberately() - Method in record class io.github.tobyjamesclements.parsley.api.ProcessStatus: Distinguishes a stop taken to preserve the guarantee from any other stop.
store() - Method in record class io.github.tobyjamesclements.parsley.api.Effects.StateWrite: Returns the value of the store record component.
store(String) - Method in class io.github.tobyjamesclements.parsley.api.ProcessDefinition: Looks up a declared store.
Store<K,V> - Class in io.github.tobyjamesclements.parsley.api: A typed key-value store a process reads and writes.
stores() - Method in class io.github.tobyjamesclements.parsley.api.ProcessDefinition: Returns the stores this process owns, in declaration order.
stores(Store...) - Method in class io.github.tobyjamesclements.parsley.api.ProcessDefinition.Builder: Declares the stores this process owns.
streamsProperty(String, Object) - Method in class io.github.tobyjamesclements.parsley.api.ParsleyConfig.Builder: Sets an additional Kafka Streams property.
SUBSTRATE_MISCONFIGURED - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: The substrate is configured in a way the guarantee cannot survive.

T

TASK_WIDTH_CHANGED - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: The task count changed, so ordering state no longer matches its partitioning.
tasks() - Method in record class io.github.tobyjamesclements.parsley.api.ProcessStatus: Returns the value of the tasks record component.
TaskStatus - Record Class in io.github.tobyjamesclements.parsley.api: The delivery state of one task of a process: what it holds, what each hold is waiting for, and how much causal metadata it carries.
TaskStatus(int, int, int, int, List) - Constructor for record class io.github.tobyjamesclements.parsley.api.TaskStatus: Copies the held channels and refuses null components.
TaskStatus.Blocker - Record Class in io.github.tobyjamesclements.parsley.api: One cause a held message is waiting for.
TaskStatus.HeldChannel - Record Class in io.github.tobyjamesclements.parsley.api: One channel with held messages.
timestamp() - Method in class io.github.tobyjamesclements.parsley.api.Delivery: Returns the message timestamp.
timestamp() - Method in record class io.github.tobyjamesclements.parsley.api.Effects.Emission: Returns the value of the timestamp record component.
timestamp() - Method in record class io.github.tobyjamesclements.parsley.core.DeliverableMessage: Returns the value of the timestamp record component.
timestamp() - Method in record class io.github.tobyjamesclements.parsley.core.ReceivedMessage: Returns the value of the timestamp record component.
toBytes() - Method in record class io.github.tobyjamesclements.parsley.core.ChannelId: Returns this channel encoded into a fresh array of ChannelId.ENCODED_LENGTH bytes.
topic() - Method in class io.github.tobyjamesclements.parsley.api.Channel: Returns the Kafka topic name.
topic() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus.Blocker: Returns the value of the topic record component.
topic() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus.HeldChannel: Returns the value of the topic record component.
topicId() - Method in record class io.github.tobyjamesclements.parsley.core.ChannelId: Returns the value of the topicId record component.
toString() - Method in class io.github.tobyjamesclements.parsley.api.Channel: Returns the topic name, wrapped for diagnostics.
toString() - Method in record class io.github.tobyjamesclements.parsley.api.Effects.Emission: Returns a string representation of this record class.
toString() - Method in record class io.github.tobyjamesclements.parsley.api.Effects.StateWrite: Returns a string representation of this record class.
toString() - Method in record class io.github.tobyjamesclements.parsley.api.ProcessDefinition.Input: Returns a string representation of this record class.
toString() - Method in record class io.github.tobyjamesclements.parsley.api.ProcessStatus: Returns a string representation of this record class.
toString() - Method in class io.github.tobyjamesclements.parsley.api.Store: Returns the store name, wrapped for diagnostics.
toString() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus.Blocker: Returns a string representation of this record class.
toString() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus.HeldChannel: Returns a string representation of this record class.
toString() - Method in record class io.github.tobyjamesclements.parsley.api.TaskStatus: Returns a string representation of this record class.
toString() - Method in class io.github.tobyjamesclements.parsley.core.Causes: Returns the frontier rendered for diagnostics.
toString() - Method in record class io.github.tobyjamesclements.parsley.core.ChannelId: Returns topicId-partition.
toString() - Method in record class io.github.tobyjamesclements.parsley.core.Deliverability.Blocker: Returns a string representation of this record class.
toString() - Method in record class io.github.tobyjamesclements.parsley.core.Deliverability.Held: Returns a string representation of this record class.
toString() - Method in record class io.github.tobyjamesclements.parsley.core.DeliverableMessage: Returns a string representation of this record class.
toString() - Method in record class io.github.tobyjamesclements.parsley.core.HeaderKV: Returns a string representation of this record class.
toString() - Method in record class io.github.tobyjamesclements.parsley.core.IdentityReport: Returns a string representation of this record class.
toString() - Method in record class io.github.tobyjamesclements.parsley.core.ReceivedMessage: Returns a string representation of this record class.
toString() - Method in record class io.github.tobyjamesclements.parsley.session.CausalPast.Coverage: Returns a string representation of this record class.
toString() - Method in class io.github.tobyjamesclements.parsley.session.CausalPast: Returns the past rendered for diagnostics.

U

UNDECODABLE_METADATA - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: Causal metadata was present but could not be decoded.
UndecodableMetadataException(String) - Constructor for exception class io.github.tobyjamesclements.parsley.core.CausesCodec.UndecodableMetadataException: Builds the exception.
UNKNOWN_ORDERING_STATE_FORMAT - Enum constant in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: Stored ordering state carries a format version this build cannot read.

V

value() - Method in class io.github.tobyjamesclements.parsley.api.Delivery: Returns the message value.
value() - Method in record class io.github.tobyjamesclements.parsley.api.Effects.Emission: Returns the value of the value record component.
value() - Method in record class io.github.tobyjamesclements.parsley.api.Effects.StateWrite: Returns the value of the value record component.
value() - Method in record class io.github.tobyjamesclements.parsley.core.DeliverableMessage: Returns the value of the value record component.
value() - Method in record class io.github.tobyjamesclements.parsley.core.HeaderKV: Returns the value of the value record component.
value() - Method in record class io.github.tobyjamesclements.parsley.core.ReceivedMessage: Returns the value of the value record component.
valueOf(String) - Static method in enum class io.github.tobyjamesclements.parsley.api.Channel.InitialPosition: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.tobyjamesclements.parsley.api.ProcessStatus.State: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.tobyjamesclements.parsley.core.ProcessEngine.ReceiveOutcome: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.github.tobyjamesclements.parsley.api.Channel.InitialPosition: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.tobyjamesclements.parsley.api.ProcessStatus.State: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.tobyjamesclements.parsley.core.ParsleyFailClosedException.Reason: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.tobyjamesclements.parsley.core.ProcessEngine.ReceiveOutcome: Returns an array containing the constants of this enum class, in the order they are declared.
valueSerde() - Method in class io.github.tobyjamesclements.parsley.api.Channel: Returns the serde for values.
valueSerde() - Method in class io.github.tobyjamesclements.parsley.api.Store: Returns the serde for values.

W

writes() - Method in class io.github.tobyjamesclements.parsley.api.Effects: Returns the state changes to apply, in declaration order.
writeTo(ByteBuffer) - Method in record class io.github.tobyjamesclements.parsley.core.ChannelId: Appends this channel to a buffer in wire order.

A B C D E F G H I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form