Module ecrontab

Data Types

add_result()

add_result() = ok | {error, Reason::any()}

ecrontab_mfa()

ecrontab_mfa() = function() | mfa() | {node(), module(), atom(), list()}

is_worker_auto_start()

is_worker_auto_start() = boolean()

max_task_count()

max_task_count() = pos_integer()

spec()

spec() = #spec{}

spec_field()

spec_field() = #spec_field{}

spec_field_any()

spec_field_any() = '?SPEC_FIELD_ANY'

spec_field_interval()

spec_field_interval() = non_neg_integer()

spec_field_list()

spec_field_list() = [spec_field_num()]

spec_field_num()

spec_field_num() = non_neg_integer()

spec_field_type()

spec_field_type() = '?SPEC_FIELD_TYPE_ANY' | '?SPEC_FIELD_TYPE_NUM' | '?SPEC_FIELD_TYPE_LIST' | '?SPEC_FIELD_TYPE_INTERVAL'

spec_field_value()

spec_field_value() = spec_field_any() | spec_field_num() | spec_field_list() | spec_field_interval()

spec_type()

spec_type() = '?SPEC_TYPE_NORMAL' | '?SPEC_TYPE_TIMESTAMP' | '?SPEC_TYPE_EVERY_SECOND' | '?SPEC_TYPE_INTERVAL_YEAR' | '?SPEC_TYPE_ONLY_ONE'

task()

task() = #task{}

task_name()

task_name() = undefined | any()

task_options()

task_options() = proplists:proplist()

worker_name()

worker_name() = any()

worker_setting()

worker_setting() = {worker_name()} | {worker_name(), max_task_count()} | {worker_name(), max_task_count(), worker_tasks()} | {worker_name(), is_worker_auto_start()} | {worker_name(), is_worker_auto_start(), worker_tasks()} | {worker_name(), max_task_count(), is_worker_auto_start(), worker_tasks()} | #{worker_name := worker_name(), max_task_count => max_task_count(), is_worker_auto_start => is_worker_auto_start(), worker_tasks => worker_tasks()}

worker_settings()

worker_settings() = [worker_setting()]

worker_task()

worker_task() = task() | {spec() | ecrontab_parse:parse_spec(), ecrontab_mfa()} | {task_name(), spec() | ecrontab_parse:parse_spec(), ecrontab_mfa()} | {task_name(), spec() | ecrontab_parse:parse_spec(), ecrontab_mfa(), task_options()}

worker_tasks()

worker_tasks() = [worker_task()]

Function Index

add/3
add/4
add/5
add_spec/4
add_spec/5
add_spec/6
add_worker/1
add_workers/1
app_performance_test/3
del/2
get_worker_count/0
loop_next_time/2
loop_next_time/3
loop_next_time_do/3
next_time_performance_test/1
parse_spec_performance_test/1
parse_task/1
parse_tasks/1
start/0
start_worker_tasks/1
stop/0
stop_worker/1
worker_list/0

Function Details

add/3

add(WorkerName::worker_name(), Spec::ecrontab_parse:parse_spec() | spec(), MFA::ecrontab_mfa()) -> add_result()

add/4

add(WorkerName::worker_name(), Spec::ecrontab_parse:parse_spec() | spec(), MFA::ecrontab_mfa(), Options::task_options()) -> add_result()

add/5

add(WorkerName::worker_name(), Name::task_name(), Spec0::ecrontab_parse:parse_spec() | spec(), MFA::ecrontab_mfa(), Options::task_options()) -> add_result()

add_spec/4

add_spec(WorkerName::worker_name(), Spec::spec(), MFA::ecrontab_mfa(), Options::task_options()) -> add_result()

add_spec/5

add_spec(WorkerName::worker_name(), Spec::spec(), MFA::ecrontab_mfa(), NowDatetime::calendar:datetime(), Options::task_options()) -> add_result()

add_spec/6

add_spec(WorkerName::worker_name(), Name::task_name(), Spec::spec(), MFA::ecrontab_mfa(), NowDatetime::calendar:datetime(), Options::task_options()) -> add_result()

add_worker/1

add_worker(Args::worker_name() | worker_setting()) -> supervisor:startchild_ret()

add_workers/1

add_workers(Workers::worker_settings()) -> ok

app_performance_test/3

app_performance_test(WorkerCount, Count, Secs) -> any()

del/2

del(WorkerPid::worker_name(), Name::task_name()) -> ok | {error, Reason::any()}

get_worker_count/0

get_worker_count() -> Count::integer()

loop_next_time/2

loop_next_time(Spec, Count) -> any()

loop_next_time/3

loop_next_time(Spec0, NowDatetime, Count) -> any()

loop_next_time_do/3

loop_next_time_do(Spec, NowDatetime, N) -> any()

next_time_performance_test/1

next_time_performance_test(Count) -> any()

parse_spec_performance_test/1

parse_spec_performance_test(Count) -> any()

parse_task/1

parse_task(X1::worker_task()) -> {ok, #task{}} | {error, any()}

parse_tasks/1

parse_tasks(WorkerTasks::worker_tasks()) -> {ok, [#task{}]} | {error, any()}

start/0

start() -> any()

start_worker_tasks/1

start_worker_tasks(WorkerName::worker_name()) -> ok | {error, no_worker}

stop/0

stop() -> any()

stop_worker/1

stop_worker(WorkerPid::worker_name()) -> ok | {error, no_worker} | {error, atom()}

worker_list/0

worker_list() -> [{worker_name(), Pid::pid()}, ...]


Generated by EDoc