CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C Queue 2.x API

  • Project:
    • Queue
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 2.x
      • 2.x
      • 1.x

Namespaces

  • Cake\Queue
    • Command
    • Consumption
    • Job
    • Listener
    • Mailer
    • Model
    • Queue
    • TestSuite
      • Constraint
      • Transport

Class TestConsumer

Test Consumer

Minimal consumer implementation for testing.

Namespace: Cake\Queue\TestSuite\Transport

Property Summary

  • $queue protected
    Interop\Queue\Queue

    Queue

Method Summary

  • __construct() public

    Constructor

  • acknowledge() public

    Acknowledge message

  • getQueue() public

    Get queue

  • receive() public

    Receive message

  • receiveNoWait() public

    Receive no wait

  • reject() public

    Reject message

Method Detail

__construct() ¶ public

__construct(Interop\Queue\Queue $queue)

Constructor

Parameters
Interop\Queue\Queue $queue

Queue

acknowledge() ¶ public

acknowledge(Message $message): void

Acknowledge message

Parameters
Message $message

Message

Returns
void

getQueue() ¶ public

getQueue(): Interop\Queue\Queue

Get queue

Returns
Interop\Queue\Queue

receive() ¶ public

receive(int|null $timeout = null): Interop\Queue\Message|null

Receive message

Timeout is in milliseconds

Parameters
int|null $timeout optional

Timeout in milliseconds

Returns
Interop\Queue\Message|null

receiveNoWait() ¶ public

receiveNoWait(): Interop\Queue\Message|null

Receive no wait

Returns
Interop\Queue\Message|null

reject() ¶ public

reject(Message $message, bool $requeue = false): void

Reject message

Parameters
Message $message

Message

bool $requeue optional

Requeue flag

Returns
void

Property Detail

$queue ¶ protected

Queue

Type
Interop\Queue\Queue
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs