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/fiber_pool.rb,
lib/solid_queue/supervisor.rb,
lib/solid_queue/thread_pool.rb,
app/models/solid_queue/batch.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,
app/models/solid_queue/batch/status.rb,
lib/solid_queue/supervisor/pidfiled.rb,
app/models/solid_queue/job/batchable.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/batch/callbacks.rb,
app/models/solid_queue/batch/clearable.rb,
app/models/solid_queue/batch/sweepable.rb,
app/models/solid_queue/batch_execution.rb,
app/models/solid_queue/job/schedulable.rb,
app/models/solid_queue/ready_execution.rb,
lib/solid_queue/dispatcher/maintenance.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,
app/models/solid_queue/failed_execution/batchable.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, Batch, BatchExecution, BlockedExecution, ClaimedExecution, Cli, Configuration, Dispatcher, Engine, Execution, FailedExecution, FiberPool, ForkSupervisor, InstallGenerator, Job, LogSubscriber, Pause, Pool, Process, Queue, QueueSelector, ReadyExecution, Record, RecurringExecution, RecurringJob, RecurringTask, ScheduledExecution, Scheduler, Semaphore, Supervisor, ThreadPool, UpdateGenerator, Worker

Constant Summary collapse

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

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.next_major_version ⇒ Object 



4
5
6
 
# File 'lib/solid_queue/version.rb', line 4

def self.next_major_version
  Gem::Version.new(VERSION).segments.first + 1
end

Instance Method Details

#deprecator ⇒ Object 



91
92
93
 
# File 'lib/solid_queue.rb', line 91

def deprecator
  @deprecator ||= ActiveSupport::Deprecation.new(next_major_version, "SolidQueue")
end

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



95
96
97
 
# File 'lib/solid_queue.rb', line 95

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

#preserve_finished_jobs? ⇒ Boolean

Returns:



87
88
89
 
# File 'lib/solid_queue.rb', line 87

def preserve_finished_jobs?
  preserve_finished_jobs
end

#schedule_recurring_task(key, **options) ⇒ Object 



57
58
59
 
# File 'lib/solid_queue.rb', line 57

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

#silence_polling? ⇒ Boolean

Returns:



83
84
85
 
# File 'lib/solid_queue.rb', line 83

def silence_polling?
  silence_polling
end

#supervisor? ⇒ Boolean

Returns:



79
80
81
 
# File 'lib/solid_queue.rb', line 79

def supervisor?
  supervisor
end

#time_zone=(zone) ⇒ Object 



48
49
50
51
52
53
 
# File 'lib/solid_queue.rb', line 48

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 



61
62
63
 
# File 'lib/solid_queue.rb', line 61

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