Class SharedStateRegistryImpl

    • Constructor Detail

      • SharedStateRegistryImpl

        public SharedStateRegistryImpl()
        Default uses direct executor to delete unreferenced state
      • SharedStateRegistryImpl

        public SharedStateRegistryImpl​(Executor asyncDisposalExecutor)
    • Method Detail

      • registerReference

        public StreamStateHandle registerReference​(SharedStateRegistryKey registrationKey,
                                                   StreamStateHandle newHandle,
                                                   long checkpointID,
                                                   boolean preventDiscardingCreatedCheckpoint)
        Description copied from interface: SharedStateRegistry
        Register a reference to the given shared state in the registry. The registry key should be based on the physical identifier of the state. If there is already a state handle registered under the same key and the 'new' state is not equal to the old one, an exception will be thrown.

        IMPORTANT: the caller must use the returned state handle instead of the passed one because the registry might replace or update it.

        Specified by:
        registerReference in interface SharedStateRegistry
        newHandle - the shared state for which we register a reference.
        checkpointID - which uses the state
        preventDiscardingCreatedCheckpoint - as long as this state is still in use. The "checkpoint that created the state" is recorded on the first state registration.
        Returns:
        the state handle registered under the given key. It might differ from the passed state handle, e.g. if it was a placeholder.
      • unregisterUnusedState

        public Set<Long> unregisterUnusedState​(long lowestCheckpointID)
        Description copied from interface: SharedStateRegistry
        Unregister state that is not referenced by the given checkpoint ID or any newer.
        Specified by:
        unregisterUnusedState in interface SharedStateRegistry
        Parameters:
        lowestCheckpointID - which is still valid.
        Returns:
        a set of checkpointID which is still in use.
      • registerAllAfterRestored

        public void registerAllAfterRestored​(CompletedCheckpoint checkpoint,
                                             RecoveryClaimMode mode)
        Description copied from interface: SharedStateRegistry
        Set the lowest checkpoint ID below which no state is discarded, inclusive.

        After recovery from an incremental checkpoint, its state should NOT be discarded, even if not used anymore (unless recovering in CLAIM mode).

        This should hold for both cases: when recovering from that initial checkpoint; and from any subsequent checkpoint derived from it.

        Specified by:
        registerAllAfterRestored in interface SharedStateRegistry