org.apache.flink.runtime.state.ttl.TtlAggregatingState Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.runtime.state.ttl;

import org.apache.flink.runtime.state.internal.InternalAggregatingState;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import java.util.Collection;

/**
 * This class wraps aggregating state with TTL logic.
 *
 * @param  The type of key the state is associated to
 * @param  The type of the namespace
 * @param  Type of the value added to the state
 * @param  The type of the accumulator (intermediate aggregate state).
 * @param  Type of the value extracted from the state
 */
class TtlAggregatingState
        extends AbstractTtlState<
                K, N, ACC, TtlValue, InternalAggregatingState, OUT>>
        implements InternalAggregatingState {

    TtlAggregatingState(
            TtlStateContext, OUT>, ACC>
                    ttlStateContext,
            TtlAggregateFunction aggregateFunction) {
        super(ttlStateContext);
        aggregateFunction.stateClear = ttlStateContext.original::clear;
        aggregateFunction.updater = ttlStateContext.original::updateInternal;
    }

    @Override
    public OUT get() throws Exception {
        accessCallback.run();
        return original.get();
    }

    @Override
    public void add(IN value) throws Exception {
        accessCallback.run();
        original.add(value);
    }

    @Nullable
    @Override
    public TtlValue getUnexpiredOrNull(@Nonnull TtlValue ttlValue) {
        return expired(ttlValue) ? null : ttlValue;
    }

    @Override
    public void clear() {
        original.clear();
    }

    @Override
    public ACC getInternal() throws Exception {
        return getWithTtlCheckAndUpdate(original::getInternal, original::updateInternal);
    }

    @Override
    public void updateInternal(ACC valueToStore) throws Exception {
        original.updateInternal(wrapWithTs(valueToStore));
    }

    @Override
    public void mergeNamespaces(N target, Collection sources) throws Exception {
        original.mergeNamespaces(target, sources);
    }
}