platform/api/laravel/Queue/BeanstalkdQueue.yaml
2024-09-02 10:44:11 -07:00

221 lines
5 KiB
YAML

name: BeanstalkdQueue
class_comment: null
dependencies:
- name: QueueContract
type: class
source: Illuminate\Contracts\Queue\Queue
- name: BeanstalkdJob
type: class
source: Illuminate\Queue\Jobs\BeanstalkdJob
- name: JobIdInterface
type: class
source: Pheanstalk\Contract\JobIdInterface
- name: Pheanstalk
type: class
source: Pheanstalk\Pheanstalk
- name: Job
type: class
source: Pheanstalk\Values\Job
- name: JobId
type: class
source: Pheanstalk\Values\JobId
- name: TubeName
type: class
source: Pheanstalk\Values\TubeName
properties:
- name: pheanstalk
visibility: protected
comment: '# * The Pheanstalk instance.
# *
# * @var \Pheanstalk\Contract\PheanstalkManagerInterface&\Pheanstalk\Contract\PheanstalkPublisherInterface&\Pheanstalk\Contract\PheanstalkSubscriberInterface'
- name: default
visibility: protected
comment: '# * The name of the default tube.
# *
# * @var string'
- name: timeToRun
visibility: protected
comment: '# * The "time to run" for all pushed jobs.
# *
# * @var int'
- name: blockFor
visibility: protected
comment: '# * The maximum number of seconds to block for a job.
# *
# * @var int'
methods:
- name: __construct
visibility: public
parameters:
- name: pheanstalk
- name: default
- name: timeToRun
- name: blockFor
default: '0'
- name: dispatchAfterCommit
default: 'false'
comment: "# * The Pheanstalk instance.\n# *\n# * @var \\Pheanstalk\\Contract\\PheanstalkManagerInterface&\\\
Pheanstalk\\Contract\\PheanstalkPublisherInterface&\\Pheanstalk\\Contract\\PheanstalkSubscriberInterface\n\
# */\n# protected $pheanstalk;\n# \n# /**\n# * The name of the default tube.\n\
# *\n# * @var string\n# */\n# protected $default;\n# \n# /**\n# * The \"time to\
\ run\" for all pushed jobs.\n# *\n# * @var int\n# */\n# protected $timeToRun;\n\
# \n# /**\n# * The maximum number of seconds to block for a job.\n# *\n# * @var\
\ int\n# */\n# protected $blockFor;\n# \n# /**\n# * Create a new Beanstalkd queue\
\ instance.\n# *\n# * @param \\Pheanstalk\\Contract\\PheanstalkManagerInterface&\\\
Pheanstalk\\Contract\\PheanstalkPublisherInterface&\\Pheanstalk\\Contract\\PheanstalkSubscriberInterface\
\ $pheanstalk\n# * @param string $default\n# * @param int $timeToRun\n# *\
\ @param int $blockFor\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: deleteMessage
visibility: public
parameters:
- name: queue
- name: id
comment: '# * Delete a message from the Beanstalk queue.
# *
# * @param string $queue
# * @param string|int $id
# * @return void'
- name: getQueue
visibility: public
parameters:
- name: queue
comment: '# * Get the queue or return the default.
# *
# * @param string|null $queue
# * @return string'
- name: getPheanstalk
visibility: public
parameters: []
comment: '# * Get the underlying Pheanstalk instance.
# *
# * @return \Pheanstalk\Contract\PheanstalkManagerInterface&\Pheanstalk\Contract\PheanstalkPublisherInterface&\Pheanstalk\Contract\PheanstalkSubscriberInterface'
traits:
- Illuminate\Queue\Jobs\BeanstalkdJob
- Pheanstalk\Contract\JobIdInterface
- Pheanstalk\Pheanstalk
- Pheanstalk\Values\Job
- Pheanstalk\Values\JobId
- Pheanstalk\Values\TubeName
interfaces:
- QueueContract