puppetlabs.trapperkeeper.services.protocols.scheduler
SchedulerServicecljprotocol
intervalclj
(interval this n f)(interval this n f group-id)Calls 'f' repeatedly with a delay of 'n' milliseconds between the beginning of a given invocation and the beginning of the following invocation. If an invocation executon time is longer than the interval, the subsquent invocation is skipped. Returns an identifier for the scheduled job. An optional group-id can be provided to collect a set of jobs into one group to allow them to be stopped together.
Calls 'f' repeatedly with a delay of 'n' milliseconds between the beginning of a given invocation and the beginning of the following invocation. If an invocation executon time is longer than the interval, the subsquent invocation is skipped. Returns an identifier for the scheduled job. An optional group-id can be provided to collect a set of jobs into one group to allow them to be stopped together.
stop-jobclj
(stop-job this job)Given an identifier of a scheduled job, stop its execution. If an invocation of the job is currently executing, it will be allowed to complete, but the job will not be invocated again. Returns 'true' if the job was successfully stopped, 'false' otherwise.
Given an identifier of a scheduled job, stop its execution. If an invocation of the job is currently executing, it will be allowed to complete, but the job will not be invocated again. Returns 'true' if the job was successfully stopped, 'false' otherwise.
cron-next-valid-timeclj
(cron-next-valid-time this cron-string date)Given a cron specification and a date, returns a date that corresponds to the next execution of the timer based on that cron value
Given a cron specification and a date, returns a date that corresponds to the next execution of the timer based on that cron value
interspacedclj
(interspaced this n f)(interspaced this n f group-id)Calls 'f' repeatedly with a delay of 'n' milliseconds between the completion of a given invocation and the beginning of the following invocation. Returns an identifier for the scheduled job. An optional group-id can be provided to collect a set of jobs into one group to allow them to be stopped together.
Calls 'f' repeatedly with a delay of 'n' milliseconds between the completion of a given invocation and the beginning of the following invocation. Returns an identifier for the scheduled job. An optional group-id can be provided to collect a set of jobs into one group to allow them to be stopped together.
count-jobsclj
(count-jobs this)(count-jobs this group-id)Return the number of jobs known to the scheduler service, or the number of jobs known to the scheduler service by group id. A nil group-id will return the count of all jobs.
Return the number of jobs known to the scheduler service, or the number of jobs known to the scheduler service by group id. A nil group-id will return the count of all jobs.
get-jobsclj
(get-jobs this)(get-jobs this group-id)Return all the known job identifiers, or the job identifiers associated with the given group.
Return all the known job identifiers, or the job identifiers associated with the given group.
interval-afterclj
(interval-after this initial-delay repeat-delay f)(interval-after this initial-delay repeat-delay f group-id)Calls 'f' repeatedly with a delay of 'repeat-delay' milliseconds after the initial-delay in millseconds.
Returns an identifier for the scheduled job. An optional
group-id can be provided to collect a set of jobs into one group to allow
them to be stopped together.
Calls 'f' repeatedly with a delay of 'repeat-delay' milliseconds after the `initial-delay` in millseconds. Returns an identifier for the scheduled job. An optional group-id can be provided to collect a set of jobs into one group to allow them to be stopped together.
cronclj
(cron this cron-string f)(cron this cron-string f group-id)Calls 'f' in accordance with the cron schedule indicated by the 'cron-string'. Returns an identifier for the scheduled job. An optional group can be provided to associated jobs with each other to allow them to be stopped together.
Calls 'f' in accordance with the cron schedule indicated by the 'cron-string'. Returns an identifier for the scheduled job. An optional group can be provided to associated jobs with each other to allow them to be stopped together.
stop-jobsclj
(stop-jobs this)(stop-jobs this group-id)Stop all the jobs associated with the service. Given an optional group-id stop only the jobs associated with that group id. Returns a sequence of maps, each with an identifier for the job and a boolean to indicate if the job was stopped successfully.
Stop all the jobs associated with the service. Given an optional group-id stop only the jobs associated with that group id. Returns a sequence of maps, each with an identifier for the job and a boolean to indicate if the job was stopped successfully.
afterclj
(after this n f)(after this n f group-id)Calls 'f' once after a delay of 'n' milliseconds. Returns an identifier for the scheduled job. An optional group can be provided to associated jobs with each other to allow them to be stopped together.
Calls 'f' once after a delay of 'n' milliseconds. Returns an identifier for the scheduled job. An optional group can be provided to associated jobs with each other to allow them to be stopped together.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close