class Illuminate / Queue / SqsQueue
You're browsing the documentation for an upcoming version of Laravel. The documentation and features of this release are subject to change.

SqsQueue

Extends

Implements

Properties

protected

$sqs Aws\...\SqsClient

The Amazon SQS instance.

Default: null
protected

$default string

The name of the default queue.

Default: null
protected

$prefix string

The queue URL prefix.

Default: null
protected

$suffix string

The queue name suffix.

Default: null

Methods

public

__construct ( Aws\...\SqsClient $sqs , $default , $prefix , $suffix , $dispatchAfterCommit ) : void

Create a new Amazon SQS queue instance.

Parameters

  • $sqs Aws\...\SqsClient
  • $default string
  • $prefix string
  • $suffix string
  • $dispatchAfterCommit bool
public

size ( $queue ) : int

Get the size of the queue.

Parameters

  • $queue string|null
public

push ( $job , $data , $queue ) : mixed

Push a new job onto the queue.

Parameters

  • $job string
  • $data mixed
  • $queue string|null
public

pushRaw ( $payload , $queue , array $options ) : mixed

Push a raw payload onto the queue.

Parameters

  • $payload string
  • $queue string|null
  • $options array
public

later ( $delay , $job , $data , $queue ) : mixed

Push a new job onto the queue after (n) seconds.

Parameters

public

bulk ( $jobs , $data , $queue ) : void

Push an array of jobs onto the queue.

Parameters

  • $jobs array
  • $data mixed
  • $queue string|null
public

pop ( $queue ) : Job |null

Pop the next job off of the queue.

Parameters

  • $queue string|null
public

clear ( $queue ) : int

Delete all of the jobs from the queue.

Parameters

  • $queue string
public

getQueue ( $queue ) : string

Get the queue or return the default.

Parameters

  • $queue string|null
protected

suffixQueue ( $queue , $suffix ) : string

Add the given suffix to the given queue name.

Parameters

  • $queue string
  • $suffix string
public

getSqs ( ) : Aws\...\SqsClient

Get the underlying SQS instance.