Overview

Namespaces

  • Avisota
    • Event
    • Message
    • Queue
    • Recipient
    • RecipientSource
    • Renderer
    • Templating
    • Test
      • Database
      • Imap
      • Message
      • Queue
      • Renderer
      • Transport
    • Transport

Classes

  • ExecutionConfig
  • QueueHelper
  • SimpleDatabaseQueue

Interfaces

  • ArchivingQueueInterface
  • EventEmittingQueueInterface
  • ExecutionDeciderInterface
  • LoggingQueueInterface
  • MutableQueueInterface
  • QueueInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Interface QueueInterface

The basic message queue interface.

Direct known implementers

Avisota\Queue\ArchivingQueueInterface, Avisota\Queue\MutableQueueInterface

Indirect known implementers

Avisota\Queue\SimpleDatabaseQueue
Namespace: Avisota\Queue
Package: avisota-core
Located at src/Avisota/Queue/QueueInterface.php
Methods summary
public boolean
# isEmpty( )

Check if the queue is empty.

Check if the queue is empty.

Returns

boolean
public integer
# length( )

Return the length of the queue.

Return the length of the queue.

Returns

integer
public Avisota\Message\MessageInterface[]
# getMessages( )

Return all messages from the queue.

Return all messages from the queue.

Returns

Avisota\Message\MessageInterface[]
public Avisota\Transport\TransportStatus[]
# execute( Avisota\Transport\TransportInterface $transport, Avisota\Queue\ExecutionConfig $config = null )

Execute a queue and send all messages.

Execute a queue and send all messages.

Parameters

$transport
Avisota\Queue\QueueInterface
$queue
$config
Avisota\Transport\TransportInterface
$transport

Returns

Avisota\Transport\TransportStatus[]
public boolean
# enqueue( Avisota\Message\MessageInterface $message, DateTime $deliveryDate = null )

Enqueue a message.

Enqueue a message.

Parameters

$message
Avisota\Message\MessageInterface
$message The message to enqueue.
$deliveryDate
DateTime
$deliveryDate The message will not delivered until this date is reached.

Returns

boolean
avisota/core API documentation generated by ApiGen 2.8.0