com.diffplug.common.rx

Interface RxTracingPolicy

All Known Implementing Classes:

RxTracingPolicy.LogSubscriptionTrace

public interface RxTracingPolicy

Plugin which gets notified of every call to Rx.subscribe, allowing various kinds of tracing.

By default, no tracing is done. To enable tracing, do one of the following:

• Execute this at the very beginning of your application: `DurianPlugins.set(RxTracingPolicy.class, new MyTracingPolicy());`
• Set this system property: `durian.plugins.com.diffplug.common.rx.RxTracingPolicy=fully.qualified.name.to.MyTracingPolicy`

LogDisposableTrace is a useful tracing policy for debugging errors within callbacks.

See Also:

DurianPlugins

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RxTracingPolicy.LogSubscriptionTrace An RxTracingPolicy which logs the stack trace of every subscription, so that it can decorate any exceptions with the stack trace at the time they were subscribed.

Field Summary

Fields

Modifier and Type	Field and Description
static RxTracingPolicy	NONE An `RxTracingPolicy` which performs no tracing, and has very low overhead.

Method Summary

Modifier and Type	Method and Description
<T> RxListener<T>	hook(Object observable, RxListener<T> listener) Given an observable, and an Rx which is about to be subscribed to this observable, return a (possibly instrumented) `Rx`.

Field Detail

NONE

static final RxTracingPolicy NONE

An `RxTracingPolicy` which performs no tracing, and has very low overhead.

Method Detail

hook

<T> RxListener<T> hook(Object observable,
                       RxListener<T> listener)

Given an observable, and an Rx which is about to be subscribed to this observable, return a (possibly instrumented) `Rx`.

Parameters:

observable - The IObservable, Observable, or ListenableFuture which is about to be subscribed to.

listener - The Rx which is about to be subscribed.

Returns:

An Rx which may (or may not) be instrumented. To ensure that the program's behavior is not changed, implementors should ensure that all method calls are delegated unchanged to the original listener eventually.