PeriodicExecutor — Documentation by YARD 0.9.37 (original) (raw)

Class: Mongo::Cluster::PeriodicExecutorPrivate

Inherits:

Object

• Object
• Mongo::Cluster::PeriodicExecutor show all

Includes:

BackgroundThread

Defined in:

lib/mongo/cluster/periodic_executor.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

A manager that calls #execute on its executors at a regular interval.

Constant Summarycollapse

FREQUENCY =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

The default time interval for the periodic executor to execute.

5

Constants included from Loggable

Loggable::PREFIX

Instance Attribute Summary collapse

• #options ⇒ Object readonly private

Instance Method Summarycollapse

• #do_work ⇒ Object private
• #execute ⇒ Object private
  Trigger an execute call on each reaper.
• #flush ⇒ Object private
  Execute all pending operations.
• #initialize(executors, options = {}) ⇒ PeriodicExecutor constructor private
  Create a periodic executor.
• #pre_stop ⇒ Object private
• #stop(final = false) ⇒ Object private

Methods included from BackgroundThread

#run!, #running?, #stop!

Methods included from Loggable

#log_debug, #log_error, #log_fatal, #log_info, #log_warn, #logger

Constructor Details

#initialize(executors, options = {}) ⇒ PeriodicExecutor

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Create a periodic executor.

Instance Attribute Details

#options ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Instance Method Details

#do_work ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

#execute ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Trigger an execute call on each reaper.

#flush ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Execute all pending operations.

#pre_stop ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

#stop(final = false) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.