summaryrefslogtreecommitdiff
path: root/src/main/java/com/amazon/carbonado/cursor/ThrottledCursor.java
blob: 2c4d7487b0295a4ed8fe07230b1a5fd9927f8881 (plain)
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/*
 * Copyright 2006-2012 Amazon Technologies, Inc. or its affiliates.
 * Amazon, Amazon.com and Carbonado are trademarks or registered trademarks
 * of Amazon Technologies, Inc. or its affiliates.  All rights reserved.
 *
 * Licensed 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 com.amazon.carbonado.cursor;

import java.util.NoSuchElementException;

import com.amazon.carbonado.Cursor;
import com.amazon.carbonado.FetchException;
import com.amazon.carbonado.FetchInterruptedException;

import com.amazon.carbonado.util.Throttle;

/**
 * Wraps another cursor and fetches results at a reduced speed.
 *
 * @author Brian S O'Neill
 */
public class ThrottledCursor<S> extends AbstractCursor<S> {
    private static final int WINDOW_SIZE = 10;
    private static final int SLEEP_PRECISION_MILLIS = 50;

    private final Cursor<S> mCursor;
    private final Throttle mThrottle;
    private final double mDesiredSpeed;

    /**
     * @param cursor cursor to wrap
     * @param throttle 1.0 = fetch at full speed, 0.5 = fetch at half speed,
     * 0.1 = fetch at one tenth speed, etc.
     */
    public ThrottledCursor(Cursor<S> cursor, double throttle) {
        mCursor = cursor;
        if (throttle < 1.0) {
            if (throttle < 0.0) {
                throttle = 0.0;
            }
            mThrottle = new Throttle(WINDOW_SIZE);
            mDesiredSpeed = throttle;
        } else {
            mThrottle = null;
            mDesiredSpeed = 1.0;
        }
    }

    public void close() throws FetchException {
        mCursor.close();
    }

    public boolean hasNext() throws FetchException {
        try {
            return mCursor.hasNext();
        } catch (NoSuchElementException e) {
            return false;
        } catch (FetchException e) {
            try {
                close();
            } catch (Exception e2) {
                // Don't care.
            }
            throw e;
        }
    }

    public S next() throws FetchException {
        try {
            throttle();
            return mCursor.next();
        } catch (FetchException e) {
            try {
                close();
            } catch (Exception e2) {
                // Don't care.
            }
            throw e;
        }
    }

    @Override
    public int skipNext(int amount) throws FetchException {
        if (amount <= 0) {
            if (amount < 0) {
                throw new IllegalArgumentException("Cannot skip negative amount: " + amount);
            }
            return 0;
        }

        try {
            int count = 0;
            while (--amount >= 0) {
                throttle();
                if (skipNext(1) <= 0) {
                    break;
                }
                count++;
            }

            return count;
        } catch (FetchException e) {
            try {
                close();
            } catch (Exception e2) {
                // Don't care.
            }
            throw e;
        }
    }

    private void throttle() throws FetchInterruptedException {
        if (mThrottle != null) {
            try {
                mThrottle.throttle(mDesiredSpeed, SLEEP_PRECISION_MILLIS);
            } catch (InterruptedException e) {
                throw new FetchInterruptedException(e);
            }
        }
    }
}