forked from ReactiveX/RxJava
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathBackpressureOverflow.java
More file actions
108 lines (90 loc) · 3.38 KB
/
BackpressureOverflow.java
File metadata and controls
108 lines (90 loc) · 3.38 KB
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
/**
* Copyright 2016 Netflix, Inc.
*
* 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 rx;
import rx.annotations.Beta;
import rx.exceptions.MissingBackpressureException;
/**
* Generic strategy and default implementations to deal with backpressure buffer overflows.
*
* @since (if this graduates from Experimental/Beta to supported, replace this parenthetical with the release number)
*/
@Beta
public final class BackpressureOverflow {
/**
* Signal a MissingBackressureException due to lack of requests.
*/
public static final BackpressureOverflow.Strategy ON_OVERFLOW_ERROR = Error.INSTANCE;
/**
* By default, signal a MissingBackressureException due to lack of requests.
*/
public static final BackpressureOverflow.Strategy ON_OVERFLOW_DEFAULT = ON_OVERFLOW_ERROR;
/**
* Drop the oldest value in the buffer.
*/
public static final BackpressureOverflow.Strategy ON_OVERFLOW_DROP_OLDEST = DropOldest.INSTANCE;
/**
* Drop the latest value.
*/
public static final BackpressureOverflow.Strategy ON_OVERFLOW_DROP_LATEST = DropLatest.INSTANCE;
/**
* Represents a callback called when a value is about to be dropped
* due to lack of downstream requests.
*/
public interface Strategy {
/**
* Whether the Backpressure manager should attempt to drop the oldest item, or simply
* drop the item currently causing backpressure.
*
* @return true to request drop of the oldest item, false to drop the newest.
* @throws MissingBackpressureException if the strategy should signal MissingBackpressureException
*/
boolean mayAttemptDrop() throws MissingBackpressureException;
}
/**
* Drop oldest items from the buffer making room for newer ones.
*/
static class DropOldest implements BackpressureOverflow.Strategy {
static final DropOldest INSTANCE = new DropOldest();
private DropOldest() {}
@Override
public boolean mayAttemptDrop() {
return true;
}
}
/**
* Drop most recent items, but not {@code onError} nor unsubscribe from source
* (as {code OperatorOnBackpressureDrop}).
*/
static class DropLatest implements BackpressureOverflow.Strategy {
static final DropLatest INSTANCE = new DropLatest();
private DropLatest() {}
@Override
public boolean mayAttemptDrop() {
return false;
}
}
/**
* {@code onError} a MissingBackpressureException and unsubscribe from source.
*/
static class Error implements BackpressureOverflow.Strategy {
static final Error INSTANCE = new Error();
private Error() {}
@Override
public boolean mayAttemptDrop() throws MissingBackpressureException {
throw new MissingBackpressureException("Overflowed buffer");
}
}
}