aboutsummaryrefslogtreecommitdiff
path: root/extras/kinesis-asl/src/main/scala/org/apache/spark/streaming/kinesis/KinesisCheckpointState.scala
blob: 0b80b611cdce79842e3e151942db8eaa2800f8b9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
/*
 * 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.spark.streaming.kinesis

import org.apache.spark.Logging
import org.apache.spark.streaming.Duration
import org.apache.spark.streaming.util.Clock
import org.apache.spark.streaming.util.ManualClock
import org.apache.spark.streaming.util.SystemClock

/**
 * This is a helper class for managing checkpoint clocks.
 *
 * @param checkpointInterval 
 * @param currentClock.  Default to current SystemClock if none is passed in (mocking purposes)
 */
private[kinesis] class KinesisCheckpointState(
    checkpointInterval: Duration, 
    currentClock: Clock = new SystemClock())
  extends Logging {
  
  /* Initialize the checkpoint clock using the given currentClock + checkpointInterval millis */
  val checkpointClock = new ManualClock()
  checkpointClock.setTime(currentClock.currentTime() + checkpointInterval.milliseconds)

  /**
   * Check if it's time to checkpoint based on the current time and the derived time 
   *   for the next checkpoint
   *
   * @return true if it's time to checkpoint
   */
  def shouldCheckpoint(): Boolean = {
    new SystemClock().currentTime() > checkpointClock.currentTime()
  }

  /**
   * Advance the checkpoint clock by the checkpoint interval.
   */
  def advanceCheckpoint() = {
    checkpointClock.addToTime(checkpointInterval.milliseconds)
  }
}