AdapterInterface Interface

Aurora\Queue\Adapter Namespace

Methods

setup

Setup queue support

Return Value

  • void

Signature

public function setup(): void
add

Add a job to the queue

Parameters

  • string $type — Job type
  • mixed $data — Job data

Return Value

  • string

Signature

public function add(string $type, mixed $data): string
get

Get a pending job to work on it

Return Value

  • \JobInterface

Signature

public function get(): Aurora\Queue\JobInterface
complete

Delete the specified job from the queue (as it is completed)

Parameters

  • string $uid — Job identifier

Return Value

  • void

Signature

public function complete(string $uid): void
failed

Mark the specified job as failed

Parameters

  • string $uid — Job identifier

Return Value

  • void

Signature

public function failed(string $uid): void
retry

Retry an specific job

Parameters

  • string $uid — Job identifier

Return Value

  • void

Signature

public function retry(string $uid): void
pending

Get the pending job count

Parameters

  • string $type — Job typeq

Return Value

  • int

Signature

public function pending(string $type = ''): int
reset

Reset failed jobs

Parameters

  • string $type — Job type

Return Value

  • void

Signature

public function reset(string $type = ''): void
purge

Purge failed jobs

Parameters

  • string $type — Job type

Return Value

  • void

Signature

public function purge(string $type = ''): void

Go to top