\Swift_FileSpool
Stores Messages on the filesystem.
- Author: Fabien Potencier
Synopsis
class Swift_FileSpool
extends Swift_ConfigurableSpool
{
- // members
- private $_path;
- private integer $_retryLimit;
- // methods
- public void __construct()
- public boolean isStarted()
- public void start()
- public void stop()
- public void setRetryLimit()
- public boolean queueMessage()
- public void recover()
- public integer flushQueue()
- protected string getRandomString()
- // Inherited methods from Swift_ConfigurableSpool
- public void setMessageLimit()
- public integer getMessageLimit()
- public void setTimeLimit()
- public integer getTimeLimit()
Hierarchy
Extends
Members
private
-
$_path
The spool directory - $_retryLimit
—
int
File WriteRetry Limit
Methods
protected
- getRandomString() — Returns a random string needed to generate a fileName for the queue.
public
- __construct() — Create a new FileSpool.
- flushQueue() — Sends messages using the given transport instance.
- isStarted() — Tests if this Spool mechanism has started.
- queueMessage() — Queues a message.
- recover() — Execute a recovery if for any reason a process is sending for too long.
- setRetryLimit() — Allow to manage the enqueuing retry limit.
- start() — Starts this Spool mechanism.
- stop() — Stops this Spool mechanism.
Inherited from Swift_ConfigurableSpool
public
- getMessageLimit() — Gets the maximum number of messages to send per flush.
- getTimeLimit() — Gets the time limit (in seconds) per flush.
- setMessageLimit() — Sets the maximum number of messages to send per flush.
- setTimeLimit() — Sets the time limit (in seconds) per flush.