Module: SolidQueue

Extended by:
SolidQueue
Included in:
SolidQueue
Defined in:
lib/solid_queue.rb,
lib/solid_queue/cli.rb,
lib/solid_queue/pool.rb,
lib/solid_queue/timer.rb,
lib/solid_queue/engine.rb,
lib/solid_queue/worker.rb,
lib/solid_queue/version.rb,
lib/solid_queue/scheduler.rb,
app/models/solid_queue/job.rb,
lib/solid_queue/dispatcher.rb,
lib/solid_queue/supervisor.rb,
app/models/solid_queue/pause.rb,
app/models/solid_queue/queue.rb,
lib/solid_queue/app_executor.rb,
app/models/solid_queue/record.rb,
lib/solid_queue/configuration.rb,
lib/solid_queue/processes/base.rb,
lib/solid_queue/fork_supervisor.rb,
lib/solid_queue/lifecycle_hooks.rb,
app/models/solid_queue/execution.rb,
app/models/solid_queue/semaphore.rb,
lib/solid_queue/async_supervisor.rb,
lib/solid_queue/supervisor/pidfile.rb,
lib/solid_queue/supervisor/signals.rb,
lib/solid_queue/supervisor/pidfiled.rb,
app/models/solid_queue/job/clearable.rb,
app/models/solid_queue/job/retryable.rb,
app/models/solid_queue/job/executable.rb,
app/models/solid_queue/job/recurrable.rb,
app/models/solid_queue/queue_selector.rb,
app/models/solid_queue/recurring_task.rb,
app/models/solid_queue/job/schedulable.rb,
app/models/solid_queue/ready_execution.rb,
lib/solid_queue/supervisor/maintenance.rb,
app/models/solid_queue/failed_execution.rb,
app/models/solid_queue/process/executor.rb,
app/models/solid_queue/process/prunable.rb,
app/models/solid_queue/blocked_execution.rb,
app/models/solid_queue/recurring_execution.rb,
app/models/solid_queue/scheduled_execution.rb,
app/models/solid_queue/execution/dispatching.rb,
lib/solid_queue/processes/process_exit_error.rb,
lib/solid_queue/scheduler/recurring_schedule.rb,
app/models/solid_queue/record/distinct_values.rb,
lib/solid_queue/processes/process_pruned_error.rb,
app/models/solid_queue/execution/job_attributes.rb,
app/models/solid_queue/job/concurrency_controls.rb,
app/models/solid_queue/recurring_task/arguments.rb,
lib/solid_queue/processes/process_missing_error.rb,
lib/solid_queue/processes/thread_terminated_error.rb,
lib/solid_queue/dispatcher/concurrency_maintenance.rb

Defined Under Namespace

Modules: AppExecutor, LifecycleHooks, Processes, Timer Classes: AsyncSupervisor, BlockedExecution, ClaimedExecution, Cli, Configuration, Dispatcher, Engine, Execution, FailedExecution, ForkSupervisor, InstallGenerator, Job, LogSubscriber, Pause, Pool, Process, Queue, QueueSelector, ReadyExecution, Record, RecurringExecution, RecurringJob, RecurringTask, ScheduledExecution, Scheduler, Semaphore, Supervisor, Worker

Constant Summary collapse

DEFAULT_LOGGER =
ActiveSupport::Logger.new($stdout)
VERSION =
"1.5.0"

Instance Method Summary collapse

Instance Method Details

#instrument(channel, **options, &block) ⇒ Object



89
90
91
# File 'lib/solid_queue.rb', line 89

def instrument(channel, **options, &block)
  ActiveSupport::Notifications.instrument("#{channel}.solid_queue", **options, &block)
end

#preserve_finished_jobs?Boolean

Returns:

  • (Boolean)


85
86
87
# File 'lib/solid_queue.rb', line 85

def preserve_finished_jobs?
  preserve_finished_jobs
end

#schedule_recurring_task(key, **options) ⇒ Object



55
56
57
# File 'lib/solid_queue.rb', line 55

def schedule_recurring_task(key, **options)
  RecurringTask.create_dynamic_task(key, **options)
end

#silence_polling?Boolean

Returns:

  • (Boolean)


81
82
83
# File 'lib/solid_queue.rb', line 81

def silence_polling?
  silence_polling
end

#supervisor?Boolean

Returns:

  • (Boolean)


77
78
79
# File 'lib/solid_queue.rb', line 77

def supervisor?
  supervisor
end

#time_zone=(zone) ⇒ Object



46
47
48
49
50
51
# File 'lib/solid_queue.rb', line 46

def time_zone=(zone)
  @@time_zone = if zone
    resolved = zone.respond_to?(:tzinfo) ? zone : ActiveSupport::TimeZone[zone]
    resolved&.tzinfo&.name || zone.to_s
  end
end

#unschedule_recurring_task(key) ⇒ Object



59
60
61
# File 'lib/solid_queue.rb', line 59

def unschedule_recurring_task(key)
  RecurringTask.delete_dynamic_task(key)
end