FilesExpand file tree

 1.x

/

RxJavaSchedulersHook.java

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

85 lines (74 loc) · 2.94 KB

 1.x

/

RxJavaSchedulersHook.java

Copy path

Top

File metadata and controls

• Code
• Blame

85 lines (74 loc) · 2.94 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

/**

* Copyright 2014 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.plugins;

import rx.Scheduler;

import rx.functions.Action0;

/**

* This plugin class provides 2 ways to customize {@link Scheduler} functionality

* 1. You may redefine entire schedulers, if you so choose. To do so, override

* the 3 methods that return Scheduler (io(), computation(), newThread()).

* 2. You may wrap/decorate an {@link Action0}, before it is handed off to a Scheduler. The system-

* supplied Schedulers (Schedulers.ioScheduler, Schedulers.computationScheduler,

* Scheduler.newThreadScheduler) all use this hook, so it's a convenient way to

* modify Scheduler functionality without redefining Schedulers wholesale.

*

* Also, when redefining Schedulers, you are free to use/not use the onSchedule decoration hook.

* <p>

* See {@link RxJavaPlugins} or the RxJava GitHub Wiki for information on configuring plugins:

* <a href="https://github.com/ReactiveX/RxJava/wiki/Plugins">https://github.com/ReactiveX/RxJava/wiki/Plugins</a>.

*/

public class RxJavaSchedulersHook {

protected RxJavaSchedulersHook() {

}

private final static RxJavaSchedulersHook DEFAULT_INSTANCE = new RxJavaSchedulersHook();

/**

* Scheduler to return from {@link rx.schedulers.Schedulers#computation()} or null if default should be

* used.

*

* This instance should be or behave like a stateless singleton;

*/

public Scheduler getComputationScheduler() {

return null;

}

/**

* Scheduler to return from {@link rx.schedulers.Schedulers#io()} or null if default should be used.

*

* This instance should be or behave like a stateless singleton;

*/

public Scheduler getIOScheduler() {

return null;

}

/**

* Scheduler to return from {@link rx.schedulers.Schedulers#newThread()} or null if default should be used.

*

* This instance should be or behave like a stateless singleton;

*/

public Scheduler getNewThreadScheduler() {

return null;

}

/**

* Invoked before the Action is handed over to the scheduler. Can be used for wrapping/decorating/logging.

* The default is just a passthrough.

* @param action action to schedule

* @return wrapped action to schedule

*/

public Action0 onSchedule(Action0 action) {

return action;

}

public static RxJavaSchedulersHook getDefaultInstance() {

return DEFAULT_INSTANCE;

}

}