Welcome to Recruiter’s documentation!

Recruiter is a Job Queue Manager built with PHP meant to be used in PHP projects.

It allows PHP developers to perform operations in the background.

Features and characteristics:

• Jobs are made persistent on MongoDB

• Jobs with complex and customizable strategies

• Jobs are stored by default in an history collection for after the fact inspection and analytics

• Multiple queues are supported through grouping

• Built to be robust, scalable and fault tolerant

At high level, it provides a few major components:

• A recruiter: a single instance long-running process that assigns enqueued jobs to workers

• A worker: multiple instance long-running processes that each execute a single job at a time

• A cleaner: a single instance long-running process that takes care of cleaning up dirty conditions that can happen (i.e. worker dead from a fatal error)

• What is Recruiter
  • Why
• Processes
  • Recruiter process
  • Worker process
  • Cleaner process
  • Logging
• Setup
  • Dependencies
  • Install
  • Setup
  • Sample
• What is a Workable object?
  • Implementing your own Workable
• Jobs
  • What is a Job
  • Hello World
  • Schedule a Job in the future
  • Retry
  • Retriable Exceptions
  • Optimistic Jobs
  • Grouping Jobs
  • Tags
• Retry Policies
  • Implements a custom RetryPolicy
  • DoNotDoItAgain
  • ExponentialBackoff
  • RetryForevers
  • RetryManyTimes
  • TimeTable
• Repeatable Jobs
• Recruiter Hooks
  • recruiter_became_master
  • recruiter_stept_back
• How to handle priority
• Analytics
• Mongo Collections
  • “roster” collection
  • “scheduled” collection
  • “archived” collection
  • “schedulers” collection
• Administration console
  • Recovering a job
  • Analytics
• Executing jobs within tests:
• Documentation to write: