class JoobQ::APIHandler

• JoobQ::APIHandler
• Reference
• Object

Overview

The APIHandler is a crucial component of the JoobQ library, designed to facilitate the integration of the JoobQ REST API with your HTTP webserver. It provides a set of predefined routes and handlers that allow you to manage job queues, enqueue new jobs, retrieve job statuses, and fetch queue metrics through HTTP requests.

Key Features:

• Job Enqueuing: Allows clients to enqueue new jobs into specified queues.
• Job Registry: Provides endpoints to retrieve the status and details of jobs.
• Queue Metrics: Offers metrics and statistics about the queues, such as the number of jobs, processing times, etc.

Usage:

To use the APIHandler, you need to include it in your HTTP server setup. This involves requiring the necessary libraries, defining your server, and starting it with the APIHandler mounted.

Example:

Here's a quick example of how to set up an HTTP server with the APIHandler:

require "http/server"
require "json"
require "joobq"

module MyApp
  class Server
    def start
      server = HTTP::Server.new([JoobQ::APIHandler.new])
      address = "0.0.0.0"
      port = 8080
      puts "Listening on http://#{address}:#{port}"
      server.bind_tcp(address, port)
      server.listen
    end
  end
end

MyApp::Server.new.start

By following these steps, you can quickly integrate the JoobQ REST API into your application, enabling robust job queue management through simple HTTP requests.

Mounting the JoobQ REST API with Your HTTP Webserver

The APIHandler is a built-in component of the JoobQ library that provides a REST API for managing job queues, enqueuing jobs, and fetching queue metrics. It is designed to be mounted on an HTTP webserver to enable clients to interact with the JoobQ library through HTTP requests.

To use the APIHandler to mount the JoobQ REST API with your own HTTP webserver, follow these steps:

Step 1: Require Necessary Libraries

require "http/server"
require "json"
require "joobq"

Step 2: Define Your HTTP Server

Create a new HTTP server and include the APIHandler from JoobQ. This handler will manage the routes for enqueuing jobs, retrieving job registry, and fetching queue metrics.

module MyApp
  class Server
    def start
      server = HTTP::Server.new([JoobQ::APIHandler.new])
      address = "0.0.0.0"
      port = 8080
      puts "Listening on http://#{address}:#{port}"
      server.bind_tcp(address, port)
      server.listen
    end
  end
end

Step 3: Start the Server

Instantiate and start your server. This will bind the server to the specified address and port, and start listening for incoming HTTP requests.

MyApp::Server.new.start

Complete Example

Here is a complete example demonstrating how to set up and start your HTTP server with the JoobQ REST API:

require "http/server"
require "json"
require "joobq"

module MyApp
  class Server
    def start
      server = HTTP::Server.new([JoobQ::APIHandler.new])
      address = "0.0.0.0"
      port = 8080
      puts "Listening on http://#{address}:#{port}"
      server.bind_tcp(address, port)
      server.listen
    end
  end
end

MyApp::Server.new.start

Additional Configuration

You can configure JoobQ by using the JoobQ.configure method to set up queues, schedulers, and other settings before starting the server.

JoobQ.configure do
  queue "default", 10, EmailJob
  scheduler do
    cron("*/1 * * * *") { # Do Something }
    every 1.hour, EmailJob, email_address: "[email protected]"
  end
end

MyApp::Server.new.start

This setup will allow you to use the JoobQ REST API with your own HTTP webserver, enabling you to enqueue jobs, retrieve job registry, and fetch queue metrics through HTTP requests.

Included Modules

• HTTP::Handler

Defined in:

joobq/api_server.cr

Constant Summary

Log = ::Log.for("API")

Instance Method Summary

• #call(context : HTTP::Server::Context)

Instance Method Detail