Class Swift_Plugin_Throttler

Description

Implements interfaces:

Throttler plugin for Swift Mailer.

Restricts the speed at which Swift will operate.

Located in /Swift/Plugin/Throttler.php (line 21)

Swift_Plugin_BandwidthMonitor
   |
   --Swift_Plugin_Throttler
Variable Summary
int $bpm
int $epm
int $sent
int $time
Method Summary
void commandSent ( $e)
int getSent ()
int getTimeLapse ()
void sendPerformed ( $e)
void setBytesPerMinute (int $bpm)
void setEmailsPerMinute (int $epm)
void setSent (int $num)
void setTime ()
void wait (int $secs)
Variables
int $bpm = null (line 27)

The rate in byte-per-minute

  • access: protected
int $epm = null (line 32)

The rate as emails-per-minute

  • access: protected
int $sent = 0 (line 37)

The number of emails sent so far

  • access: protected
int $time = null (line 42)

The time at the start of overall execution

  • access: protected

Inherited Variables

Inherited from Swift_Plugin_BandwidthMonitor

Swift_Plugin_BandwidthMonitor::$in
Swift_Plugin_BandwidthMonitor::$out
Methods
commandSent (line 48)

Part of the interface which is notified after a command is sent.

  • access: public
void commandSent ( $e)

Redefinition of:
Swift_Plugin_BandwidthMonitor::commandSent()
Part of the interface which is notified after a command is sent.
getBytesPerMinute (line 141)

Get the number of bytes allowed per minute.

Reurns NULL if not used.

  • access: public
int getBytesPerMinute ()
getEmailsPerMinute (line 164)

Get the rate as number of emails per minute.

Returns null if not used.

  • access: public
int getEmailsPerMinute ()
getSent (line 118)

Get the number of emails sent

  • access: public
int getSent ()
getTimeLapse (line 101)

Get the time taken thus far (full seconds).

  • access: public
int getTimeLapse ()
sendPerformed (line 67)

Part of the interface which is notified when a message has been sent.

  • access: public
void sendPerformed ( $e)
setBytesPerMinute (line 126)

Set the throttling rate as bytes per minute

  • access: public
void setBytesPerMinute (int $bpm)
  • int $bpm: The maximum number of outgoing bytes in 60 seconds.
setEmailsPerMinute (line 149)

Set the rate as emails-per-minute.

  • access: public
void setEmailsPerMinute (int $epm)
  • int $epm: The max number of emails to send in a minute.
setSent (line 110)

Set the number of emails sent

  • access: public
void setSent (int $num)
  • int $num: Emails sent so far
setTime (line 93)

Set the time if it's not already set

  • access: protected
void setTime ()
wait (line 86)

Wait for $seconds before continuing

  • access: public
void wait (int $secs)
  • int $secs: The number of seconds to wait

Inherited Methods

Inherited From Swift_Plugin_BandwidthMonitor

Swift_Plugin_BandwidthMonitor::addBytesIn()
Swift_Plugin_BandwidthMonitor::addBytesOut()
Swift_Plugin_BandwidthMonitor::commandSent()
Swift_Plugin_BandwidthMonitor::getBytesIn()
Swift_Plugin_BandwidthMonitor::getBytesOut()
Swift_Plugin_BandwidthMonitor::responseReceived()
Swift_Plugin_BandwidthMonitor::setBytesIn()
Swift_Plugin_BandwidthMonitor::setBytesOut()

Documentation generated on Wed, 26 Mar 2008 20:33:11 +1100 by phpDocumentor 1.3.1