integration_resequencer 1.0.0

class: Resequencer

[50:14] (extern: com.lehman.aussom.Resequencer) extends: object

Resequencer takes messages that arrive out of order and releases them in order, one at a time, by sequence number. It holds back a message that arrives early until the messages that should come before it have been released, then lets the run through. It is an Aussom Server client listener: register it with app.registerListener and the server runtime runs its background sweeper on a dedicated thread. Feed it messages with accept() from any thread. The Resequencer is standalone and generic. It defines no message type and the payload may be any Aussom value. Only the sequence number and payload are required; an optional correlation id lets one Resequencer reorder several independent streams at once, each tracked on its own. The head (lowest buffered message) is released when it is the immediate successor of the last released number (no delay), when the buffer exceeds the capacity, or when it has waited the hold window (setTimeoutMs). A zero hold window releases the first message that arrives at once and drops any later, lower number as late.

Methods

• Resequencer (string Name)

  Creates a new Resequencer.

  • @p Name is the stable listener name used in logs and applications.yaml.

• newResequencer (string Name)

• setTimeoutMs (int Ms)

  Sets the hold window in milliseconds: how long the head of a stream waits for a missing predecessor before it is released anyway. Default 1000. A value of 0 disables the hold (the first message to arrive is taken as the start and released at once).

  • @p Ms is an int with the hold window in milliseconds (>= 0).
  • @r this object

• setCapacity (int N)

  Sets the maximum number of buffered messages per stream before the head is force-released to bound memory, even past a gap. Default 0 (unbounded).

  • @p N is an int with the per-stream buffer cap (>= 0).
  • @r this object

• setReapIntervalMs (int Ms)

  Sets how often the sweeper runs, in milliseconds. Default 1000.

  • @p Ms is an int with the sweep interval in milliseconds (> 0).
  • @r this object

• setOnRelease (callback Cb)

  Sets the release handler, called as Cb(SequenceNumber, Payload, CorrelationId) for each released message, in order. CorrelationId is null for the default stream. Required.

  • @p Cb is the release handler callback.
  • @r this object

• setOnGap (callback Cb)

  Sets the gap handler, called as Cb(SkippedSequence, CorrelationId) when the timeout or capacity rule skips a missing message. CorrelationId is null for the default stream. Optional.

  • @p Cb is the gap handler callback.
  • @r this object

• accept (SequenceNumber, Payload, CorrelationId = null)

  Feeds one message into its stream. Releases any now-deliverable messages on the calling thread.

  • @p SequenceNumber is an int with the message's position in its stream.
  • @p Payload is the message, any Aussom value.
  • @p CorrelationId is an optional string naming an independent stream (default null, the single default stream).
  • @r this object

• acceptMsg (SequenceNumber, Payload, CorrelationId)

• startListener ()

  Runs the sweeper loop on the calling thread, blocking until stopListener() is called. Under Aussom Server the runtime drives this after app.registerListener; called directly for plain-CLI use and tests.

  • @r this object

• stopListener ()

  Signals the sweeper loop to exit.

  • @r this object

• pauseListener ()

  Pauses the timeout and capacity sweeps without dropping buffered state.

  • @r this object

• resumeListener ()

  Resumes the sweeps after pauseListener().

  • @r this object

• getListenerName ()

  Gets the resequencer (listener) name.

  • @r A string with the name.

• getIsRunning ()

  Reports whether the sweeper loop is running.

  • @r A bool, true while running.

• getIsPaused ()

  Reports whether the sweeper is paused.

  • @r A bool, true while paused.

class: integration_resequencer_module

[23:14] static extends: object

Module JAR loader class. Loads the bundled jar that backs the Resequencer before any extern class resolves.

Methods

• integration_resequencer_module ()