Teek API Documentation

Teek::BackgroundRactor4x::BackgroundWork::TaskContext Class

Context object passed to the worker block inside the Ractor. Provides methods for yielding results, sending/receiving messages, and responding to pause/stop signals.

Inherits: Object

Instance Methods ↑

check_message

Non-blocking check for a message from the main thread. Handles built-in control messages (:pause, :resume, :stop) automatically; :stop raises StopIteration.

Returns Object, nil — the message, or nil if none pending

View source ▼ 
def check_message
  return nil if @msg_queue.empty?
  msg = @msg_queue.pop(true)
  handle_control_message(msg)
  msg
rescue ThreadError
  nil
end
GitHub

check_pause

Block while paused, returning immediately if not paused. Call this periodically in long-running loops to honor pause requests.

View source ▼ 
def check_pause
  check_pause_loop
end
GitHub

initialize(output_port, msg_queue)

Returns TaskContext — a new instance of TaskContext

@api private

View source ▼ 
def initialize(output_port, msg_queue)
  @output_port = output_port
  @msg_queue = msg_queue
  @paused = false
end
GitHub

send_message(msg)

Send a custom message back to the main thread. Arrives in the BackgroundWork#on_message callback.

Parameters
  • msg Object — any Ractor-shareable value
View source ▼ 
def send_message(msg)
  @output_port.send([:message, msg])
end
GitHub

wait_message

Blocking wait for the next message from the main thread. Handles control messages automatically.

Returns Object — the message

View source ▼ 
def wait_message
  msg = @msg_queue.pop
  handle_control_message(msg)
  msg
end
GitHub

yield(value)

Send a result to the main thread. Blocks while paused. The value arrives in the BackgroundWork#on_progress callback.

Parameters
  • value Object — any Ractor-shareable value
View source ▼ 
def yield(value)
  check_pause_loop
  @output_port.send([:result, value])
end
GitHub