Classes List

Swift_Plugins_AntiFloodPlugin

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
<?php

/* * This file is part of SwiftMailer. * (c) 2004-2009 Chris Corbyn * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


/** * Reduces network flooding when sending large amounts of mail. * * @author Chris Corbyn */
class Swift_Plugins_AntiFloodPlugin implements Swift_Events_SendListenerSwift_Plugins_Sleeper
{
    /** * The number of emails to send before restarting Transport. * * @var int */
    private $threshold;

    /** * The number of seconds to sleep for during a restart. * * @var int */
    private $sleep;

    /** * The internal counter. * * @var int */
    private $counter = 0;

    /** * The Sleeper instance for sleeping. * * @var Swift_Plugins_Sleeper */
    private $sleeper;

    /** * Create a new AntiFloodPlugin with $threshold and $sleep time. * * @param int $threshold * @param int $sleep time * @param Swift_Plugins_Sleeper $sleeper (not needed really) */
    public function __construct($threshold = 99$sleep = 0Swift_Plugins_Sleeper $sleeper = null)
    {
        $this->setThreshold($threshold);
        $this->setSleepTime($sleep);
        $this->sleeper = $sleeper;
    }

    /** * Set the number of emails to send before restarting. * * @param int $threshold */
    public function setThreshold($threshold)
    {
        $this->threshold = $threshold;
    }

    /** * Get the number of emails to send before restarting. * * @return int */
    public function getThreshold()
    {
        return $this->threshold;
    }

    /** * Set the number of seconds to sleep for during a restart. * * @param int $sleep time */
    public function setSleepTime($sleep)
    {
        $this->sleep = $sleep;
    }

    /** * Get the number of seconds to sleep for during a restart. * * @return int */
    public function getSleepTime()
    {
        return $this->sleep;
    }

    /** * Invoked immediately before the Message is sent. */
    public function beforeSendPerformed(Swift_Events_SendEvent $evt)
    {
    }

    /** * Invoked immediately after the Message is sent. */
    public function sendPerformed(Swift_Events_SendEvent $evt)
    {
        ++$this->counter;
        if ($this->counter >= $this->threshold) {
            $transport = $evt->getTransport();
            $transport->stop();
            if ($this->sleep) {
                $this->sleep($this->sleep);
            }
            $transport->start();
            $this->counter = 0;
        }
    }

    /** * Sleep for $seconds. * * @param int $seconds */
    public function sleep($seconds)
    {
        if (isset($this->sleeper)) {
            $this->sleeper->sleep($seconds);
        } else {
            sleep($seconds);
        }
    }
}