222 lines
4.4 KiB
YAML
222 lines
4.4 KiB
YAML
name: SqsQueue
|
|
class_comment: null
|
|
dependencies:
|
|
- name: SqsClient
|
|
type: class
|
|
source: Aws\Sqs\SqsClient
|
|
- name: ClearableQueue
|
|
type: class
|
|
source: Illuminate\Contracts\Queue\ClearableQueue
|
|
- name: QueueContract
|
|
type: class
|
|
source: Illuminate\Contracts\Queue\Queue
|
|
- name: SqsJob
|
|
type: class
|
|
source: Illuminate\Queue\Jobs\SqsJob
|
|
- name: Str
|
|
type: class
|
|
source: Illuminate\Support\Str
|
|
properties:
|
|
- name: sqs
|
|
visibility: protected
|
|
comment: '# * The Amazon SQS instance.
|
|
|
|
# *
|
|
|
|
# * @var \Aws\Sqs\SqsClient'
|
|
- name: default
|
|
visibility: protected
|
|
comment: '# * The name of the default queue.
|
|
|
|
# *
|
|
|
|
# * @var string'
|
|
- name: prefix
|
|
visibility: protected
|
|
comment: '# * The queue URL prefix.
|
|
|
|
# *
|
|
|
|
# * @var string'
|
|
- name: suffix
|
|
visibility: protected
|
|
comment: '# * The queue name suffix.
|
|
|
|
# *
|
|
|
|
# * @var string'
|
|
methods:
|
|
- name: __construct
|
|
visibility: public
|
|
parameters:
|
|
- name: sqs
|
|
- name: default
|
|
- name: prefix
|
|
default: ''''''
|
|
- name: suffix
|
|
default: ''''''
|
|
- name: dispatchAfterCommit
|
|
default: 'false'
|
|
comment: "# * The Amazon SQS instance.\n# *\n# * @var \\Aws\\Sqs\\SqsClient\n# */\n\
|
|
# protected $sqs;\n# \n# /**\n# * The name of the default queue.\n# *\n# * @var\
|
|
\ string\n# */\n# protected $default;\n# \n# /**\n# * The queue URL prefix.\n\
|
|
# *\n# * @var string\n# */\n# protected $prefix;\n# \n# /**\n# * The queue name\
|
|
\ suffix.\n# *\n# * @var string\n# */\n# protected $suffix;\n# \n# /**\n# * Create\
|
|
\ a new Amazon SQS queue instance.\n# *\n# * @param \\Aws\\Sqs\\SqsClient $sqs\n\
|
|
# * @param string $default\n# * @param string $prefix\n# * @param string\
|
|
\ $suffix\n# * @param bool $dispatchAfterCommit\n# * @return void"
|
|
- name: size
|
|
visibility: public
|
|
parameters:
|
|
- name: queue
|
|
default: 'null'
|
|
comment: '# * Get the size of the queue.
|
|
|
|
# *
|
|
|
|
# * @param string|null $queue
|
|
|
|
# * @return int'
|
|
- name: push
|
|
visibility: public
|
|
parameters:
|
|
- name: job
|
|
- name: data
|
|
default: ''''''
|
|
- name: queue
|
|
default: 'null'
|
|
comment: '# * Push a new job onto the queue.
|
|
|
|
# *
|
|
|
|
# * @param string $job
|
|
|
|
# * @param mixed $data
|
|
|
|
# * @param string|null $queue
|
|
|
|
# * @return mixed'
|
|
- name: pushRaw
|
|
visibility: public
|
|
parameters:
|
|
- name: payload
|
|
- name: queue
|
|
default: 'null'
|
|
- name: options
|
|
default: '[]'
|
|
comment: '# * Push a raw payload onto the queue.
|
|
|
|
# *
|
|
|
|
# * @param string $payload
|
|
|
|
# * @param string|null $queue
|
|
|
|
# * @param array $options
|
|
|
|
# * @return mixed'
|
|
- name: later
|
|
visibility: public
|
|
parameters:
|
|
- name: delay
|
|
- name: job
|
|
- name: data
|
|
default: ''''''
|
|
- name: queue
|
|
default: 'null'
|
|
comment: '# * Push a new job onto the queue after (n) seconds.
|
|
|
|
# *
|
|
|
|
# * @param \DateTimeInterface|\DateInterval|int $delay
|
|
|
|
# * @param string $job
|
|
|
|
# * @param mixed $data
|
|
|
|
# * @param string|null $queue
|
|
|
|
# * @return mixed'
|
|
- name: bulk
|
|
visibility: public
|
|
parameters:
|
|
- name: jobs
|
|
- name: data
|
|
default: ''''''
|
|
- name: queue
|
|
default: 'null'
|
|
comment: '# * Push an array of jobs onto the queue.
|
|
|
|
# *
|
|
|
|
# * @param array $jobs
|
|
|
|
# * @param mixed $data
|
|
|
|
# * @param string|null $queue
|
|
|
|
# * @return void'
|
|
- name: pop
|
|
visibility: public
|
|
parameters:
|
|
- name: queue
|
|
default: 'null'
|
|
comment: '# * Pop the next job off of the queue.
|
|
|
|
# *
|
|
|
|
# * @param string|null $queue
|
|
|
|
# * @return \Illuminate\Contracts\Queue\Job|null'
|
|
- name: clear
|
|
visibility: public
|
|
parameters:
|
|
- name: queue
|
|
comment: '# * Delete all of the jobs from the queue.
|
|
|
|
# *
|
|
|
|
# * @param string $queue
|
|
|
|
# * @return int'
|
|
- name: getQueue
|
|
visibility: public
|
|
parameters:
|
|
- name: queue
|
|
comment: '# * Get the queue or return the default.
|
|
|
|
# *
|
|
|
|
# * @param string|null $queue
|
|
|
|
# * @return string'
|
|
- name: suffixQueue
|
|
visibility: protected
|
|
parameters:
|
|
- name: queue
|
|
- name: suffix
|
|
default: ''''''
|
|
comment: '# * Add the given suffix to the given queue name.
|
|
|
|
# *
|
|
|
|
# * @param string $queue
|
|
|
|
# * @param string $suffix
|
|
|
|
# * @return string'
|
|
- name: getSqs
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * Get the underlying SQS instance.
|
|
|
|
# *
|
|
|
|
# * @return \Aws\Sqs\SqsClient'
|
|
traits:
|
|
- Aws\Sqs\SqsClient
|
|
- Illuminate\Contracts\Queue\ClearableQueue
|
|
- Illuminate\Queue\Jobs\SqsJob
|
|
- Illuminate\Support\Str
|
|
interfaces:
|
|
- QueueContract
|