observeSignalNewNym
Subscribes with provided TorRuntime a CMD observer which will intercept execution of all TorCmd.Signal.NewNym jobs in order to transform tor's generic server response of Reply.Success.OK.
The generic server response only indicates that tor has accepted the command. Anything tor does as a result of that command is (typically) dispatched as TorEvent.NOTICE.
Specific to TorCmd.Signal.NewNym, if tor accepted the signal, it may or may not dispatch a TorEvent.NOTICE indicating that it was rate-limited. This observer handles that transformation and notifies the provided onEvent callback whenever there is a successful execution of a TorCmd.Signal.NewNym job with either:
null: tor accepted the signal without rate-limiting.
non-null: the rate-limiting notice.
e.g.
val disposable = myTorRuntime.observeSignalNewNym(
"my tag",
null,
) { rateLimiting ->
println(rateLimiting ?: "You've changed Tor identities!")
}
try {
myTorRuntime.startDaemonAsync()
myTorRuntime.executeAsync(TorCmd.Signal.NewNym)
myTorRuntime.executeAsync(TorCmd.Signal.NewNym)
myTorRuntime.executeAsync(TorCmd.Signal.NewNym)
myTorRuntime.executeAsync(TorCmd.Signal.NewNym)
} finally {
disposable.dispose()
}
// You've changed Tor identities!
// Rate limiting NEWNYM request: delaying by 10 second(s)
// Rate limiting NEWNYM request: delaying by 10 second(s)
// Rate limiting NEWNYM request: delaying by 10 second(s)Return
Disposable to unsubscribe the observer
Parameters
A string to help grouping/identifying observer(s)
The thread context in which onEvent will be invoked in. If null whatever was declared via TorRuntime.Environment.BuilderScope.defaultEventExecutor is used.
The callback to pass the data to.