| Overview |  |
Version: 1.42.1
| format/1 | Equivalent to format(Fmt, []). |
| format/2 | Syncronized io:format. |
| get_events/0 | Obtain the events that pulse has used for scheduling processes. |
| get_schedule/0 | Obtain the schedule that pulse has used for scheduling processes. |
| get_seed/0 | Obtain the seed that the scheduler uses for scheduling processes. |
| import_process/1 | When executed by a process not managed by PULSE, this function makes PULSE adopt the process as one of its own. |
| is_instrumented/1 | Checks whether the code is compiled using the pulse instrument parse transformation. |
| rerun/0 | Run the same function as before scheduled by pulse. |
| rerun_counterexample/2 | Re-run the last counterexample found by QuickCheck
(counterexample returned by
eqc:counterexample/0) with the verbosity specified in the first argument
(see verbose/1). |
| rerun_counterexample/3 | Re-run the counterexample for the property with verbosity as specified in first argument. |
| rerun_verbose/1 | Run the same function as before
scheduled by pulse with verbosity set as in the function
verbose. |
| run/1 | Equivalent to run(Fun, []). |
| run/2 | Run a function scheduled by pulse. |
| seed/0 | Seed generator to be used in combination with for example the seed option in run/2. |
| start/0 | Start pulse as an application, it consists of a supervisor tree with an event manager and the pulse process. |
| stop/0 | Stop pulse application. |
| verbose/1 | Set verbose mode of all attached event handlers to items given as arguments. |
format(Fmt) -> any()
Equivalent to format(Fmt, []).
format(Fmt, Args) -> any()
Syncronized io:format. The normal io:format/2 function is a side-effect function and
using it for printing debug statements does not work particularly well. When using print
commands for debugging in a PULSE context, one should use this format function instead.
Note that the printed commands only become visible when the format option is passed to
the verbose/1 function.
get_events() -> events()
Obtain the events that pulse has used for scheduling processes
get_schedule() -> schedule()
Obtain the schedule that pulse has used for scheduling processes
Obtain the seed that the scheduler uses for scheduling processes
import_process(NameHint) -> any()
When executed by a process not managed by PULSE, this function makes PULSE adopt the process as one of its own. The typical use case is when you have control over (and can instrument) the code executed by a process, but not the code that is spawning the process.
is_instrumented(Module::atom()) -> bool()
Checks whether the code is compiled using the pulse instrument parse transformation.
rerun() -> term()
Run the same function as before scheduled by pulse. The result of the scheduled run is one of the possible outcomes of running the function without the scheduler. In this way one need not copy the function to the scheduling process each time.
rerun_counterexample(FlagList::[atom()], Property::property()) -> any()
Re-run the last counterexample found by QuickCheck
(counterexample returned by
eqc:counterexample/0) with the verbosity specified in the first argument
(see verbose/1).
Uses eqc:check/2 to re-evaluate the property.
rerun_counterexample(FlagList::[atom()], Property::property(), Example::counterexample()) -> any()
Re-run the counterexample for the property with verbosity as specified in first argument. Uses eqc:check/2 to re-evaluate the property.
rerun_verbose(FlagList::[atom()]) -> term()
Run the same function as before
scheduled by pulse with verbosity set as in the function
verbose. The verbosity is only changed during the rerun.
The result
of the scheduled run is one of the possible outcomes of
running the function without the scheduler.
In this way one need not copy the function to the
scheduling process each time.
run(Fun::function()) -> term()
Equivalent to run(Fun, []).
run(Fun::function(), Options::proplist()) -> term()
Run a function scheduled by pulse. The result of the scheduled run is one of the possible outcomes of running the function without the scheduler. The following options can be provided:
Seed generator to be used in combination with for example the seed option in run/2.
The idea is to have QuickCheck generate a seed with this generator and pass
this on to pulse.
start() -> {ok, Pid} | error
Start pulse as an application, it consists of a supervisor tree with an event manager and the pulse process. One can add event handlers dynamically
stop() -> ok
Stop pulse application.
verbose(FlagList::[atom()]) -> [atom()]
Set verbose mode of all attached event handlers to items given as arguments. We support flags similar to those in erlang:trace/3.
pulse_instrument).format/2 in the verbose output.Generated by EDoc, Sep 18 2017, 16:17:35.