Module jobs_sampler

This module defines the jobs_sampler behaviour.
Required callback functions: init/2, sample/2, handle_msg/3, calc/2.

Authors: : Ulf Wiger (ulf@wiger.net).

Data Types

counter()

abstract datatype: counter()

reg_obj()

abstract datatype: reg_obj()

Function Index

calc/3
code_change/3
end_subscription/0
handle_call/3
handle_cast/2
handle_info/2
init/1
start_link/0
start_link/1
subscribe/0Subscribes to feedback indicator information.
tell_sampler/2
terminate/2
trigger_sample/0

Function Details

calc/3

calc(Type, Template, History) -> any()

code_change/3

code_change(FromVsn, State, Extra) -> any()

end_subscription/0

end_subscription() -> any()

handle_call/3

handle_call(X1, From, State) -> any()

handle_cast/2

handle_cast(X1, S) -> any()

handle_info/2

handle_info(Msg, State) -> any()

init/1

init(Opts) -> any()

start_link/0

start_link() -> any()

start_link/1

start_link(Opts) -> any()

subscribe/0

subscribe() -> ok

Subscribes to feedback indicator information

This function allows a process to receive the same information as the jobs_server any time the information changes.

The notifications are delivered on the format {jobs_indicators, Info}, where
  Info :: [{IndicatorName, LocalValue, Remote}]
   Remote :: [{NodeName, Value}]
  
This information could be used e.g. to aggregate the information and generate new sampler information (which could be passed to a sampler plugin using tell_sampler/2, or to a specific queue using jobs:ask_queue/2.

tell_sampler/2

tell_sampler(P, Msg) -> any()

terminate/2

terminate(X1, S) -> any()

trigger_sample/0

trigger_sample() -> any()


Generated by EDoc