Teek::BackgroundWork Class

close

Force-close the worker and associated resources.

Returns self

View source ▼

def close
  @impl.close if @impl.respond_to?(:close)
  self
end

done?

Returns Boolean

View source ▼

def done?
  @impl.done?
end

initialize(app, data, mode: :thread, worker: nil, &block)

Parameters

• app Teek::App — the application instance
• data Object — data passed to the worker block
• mode Symbol — :thread or :ractor
• worker Class, nil — optional worker class (must respond to #call(task, data))

Returns BackgroundWork — a new instance of BackgroundWork

@raise ArgumentError if mode is unknown

@yield task, data block executed in the background

@yieldparam task BackgroundThread::BackgroundWork::TaskContext, BackgroundRactor4x::BackgroundWork::TaskContext

@yieldparam data Object

View source ▼

def initialize(app, data, mode: :thread, worker: nil, &block)
  impl_class = self.class.background_mode_class(mode)
  unless impl_class
    available = self.class.background_modes.keys.join(', ')
    raise ArgumentError, "Unknown mode: #{mode}. Available: #{available}"
  end

  @impl = impl_class.new(app, data, worker: worker, &block)
  @mode = mode
  @name = nil
end

mode

Returns Symbol — the active mode (:thread or :ractor)

View source ▼

def mode
  @mode
end

on_done(&block)

Returns self

@yield called on the main thread when the worker completes

View source ▼

def on_done(&block)
  @impl.on_done(&block)
  self
end

on_message(&block)

Returns self

@yield msg called on the main thread with custom worker messages

View source ▼

def on_message(&block)
  @impl.on_message(&block)
  self
end

on_progress(&block)

Returns self

@yield value called on the main thread with each result

View source ▼

def on_progress(&block)
  @impl.on_progress(&block)
  self
end

pause

Pause the worker.

Returns self

View source ▼

def pause
  @impl.pause
  self
end

paused?

Returns Boolean

View source ▼

def paused?
  @impl.paused?
end

resume

Resume a paused worker.

Returns self

View source ▼

def resume
  @impl.resume
  self
end

send_message(msg)

Send a message to the worker.

Parameters

• msg Object — any value (must be Ractor-shareable in :ractor mode)

Returns self

View source ▼

def send_message(msg)
  @impl.send_message(msg)
  self
end

start

Explicitly start the worker. Called automatically by #on_progress and #on_done.

Returns self

View source ▼

def start
  @impl.start
  self
end

stop

Request the worker to stop.

Returns self

View source ▼

def stop
  @impl.stop
  self
end