Skip to content

Commit

Permalink
Jobs (#46)
Browse files Browse the repository at this point in the history
* Job docs

* Update Package.swift

* Update Package.swift
  • Loading branch information
adam-fowler authored Aug 29, 2024
1 parent a114694 commit e7a048e
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 3 deletions.
39 changes: 39 additions & 0 deletions Hummingbird.docc/Jobs/JobQueueDriver.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# ``/Jobs/JobQueueDriver``

@Metadata {
@DocumentationExtension(mergeBehavior: override)
}
Protocol for job queue driver

## Overview

Defines the requirements for job queue implementation.

## Topics

### Associated Types

- ``JobID``

### Lifecycle

- ``onInit()``
- ``stop()``
- ``shutdownGracefully()``

### Jobs

- ``push(_:)``
- ``finished(jobId:)``
- ``failed(jobId:error:)``

### Metadata

- ``getMetadata(_:)``
- ``setMetadata(key:value:)``

### Implementations

- ``memory``
- ``redis(_:configuration:)``
- ``postgres(client:migrations:configuration:logger:)``
5 changes: 5 additions & 0 deletions Hummingbird.docc/Jobs/Jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ A Job consists of a payload and an execute method to run the job. `Jobs` provide
- ``QueuedJob``
- ``MemoryQueue``

### Scheduler

- ``JobSchedule``
- ``Schedule``

### Error

- ``JobQueueError``
Expand Down
6 changes: 3 additions & 3 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ let package = Package(
.package(url: "https://github.com/hummingbird-project/hummingbird-auth.git", from: "2.0.0-rc.1"),
.package(url: "https://github.com/hummingbird-project/hummingbird-compression.git", from: "2.0.0-alpha.2"),
.package(url: "https://github.com/hummingbird-project/hummingbird-fluent.git", from: "2.0.0-beta.2"),
.package(url: "https://github.com/hummingbird-project/swift-jobs.git", from: "1.0.0-beta.1"),
.package(url: "https://github.com/hummingbird-project/swift-jobs-redis.git", from: "1.0.0-beta.2"),
.package(url: "https://github.com/hummingbird-project/swift-jobs.git", from: "1.0.0-beta.2"),
.package(url: "https://github.com/hummingbird-project/swift-jobs-redis.git", from: "1.0.0-beta.4"),
.package(url: "https://github.com/hummingbird-project/hummingbird-lambda.git", from: "2.0.0-rc.1"),
.package(url: "https://github.com/hummingbird-project/swift-mustache.git", from: "2.0.0-beta.1"),
.package(url: "https://github.com/hummingbird-project/hummingbird-postgres.git", from: "0.2.0"),
.package(url: "https://github.com/hummingbird-project/hummingbird-postgres.git", from: "0.3.0"),
.package(url: "https://github.com/hummingbird-project/hummingbird-redis.git", from: "2.0.0-beta.2"),
.package(url: "https://github.com/hummingbird-project/hummingbird-websocket.git", from: "2.0.0-rc.1"),
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0")
Expand Down

0 comments on commit e7a048e

Please sign in to comment.