Class Swift_Plugins_ThrottlerPlugin

Throttles the rate at which emails are sent.

Swift_Plugins_BandwidthMonitorPlugin implements Swift_Events_SendListener, Swift_Events_CommandListener, Swift_Events_ResponseListener, Swift_InputByteStream

Swift_Plugins_ThrottlerPlugin implements Swift_Plugins_Sleeper, Swift_Plugins_Timer

Package: Swift\Plugins
Author: Chris Corbyn
Located at vendors/swiftmailer/lib/classes/Swift/Plugins/ThrottlerPlugin.php

Methods summary

`public`	# `__construct( integer $rate, integer $mode = Swift_Plugins_ThrottlerPlugin::BYTES_PER_MINUTE, Swift_Plugins_Sleeper $sleeper = null, Swift_Plugins_Timer $timer = null )` Create a new ThrottlerPlugin. Create a new ThrottlerPlugin. Parameters `$rate` `integer` $rate `$mode` `integer` $mode, defaults to `Swift_Plugins_ThrottlerPlugin::BYTES_PER_MINUTE` `$sleeper` `Swift_Plugins_Sleeper` $sleeper (only needed in testing) `$timer` `Swift_Plugins_Timer` $timer (only needed in testing)
`public`	# `beforeSendPerformed( Swift_Events_SendEvent $evt )` Invoked immediately before the Message is sent. Invoked immediately before the Message is sent. Parameters `$evt` `Swift_Events_SendEvent` $evt Overrides `Swift_Plugins_BandwidthMonitorPlugin::beforeSendPerformed`
`public`	# `sendPerformed( Swift_Events_SendEvent $evt )` Invoked when a Message is sent. Invoked when a Message is sent. Parameters `$evt` `Swift_Events_SendEvent` $evt Overrides `Swift_Plugins_BandwidthMonitorPlugin::sendPerformed`
`public`	# `sleep( integer $seconds )` Sleep for $seconds. Sleep for $seconds. Parameters `$seconds` `integer` $seconds Implementation of `Swift_Plugins_Sleeper::sleep()`
`public integer`	# `getTimestamp( )` Get the current UNIX timestamp Get the current UNIX timestamp Returns `integer` Implementation of `Swift_Plugins_Timer::getTimestamp()`
`private integer`	# `_throttleBytesPerMinute( integer $timePassed )` Get a number of seconds to sleep for. Get a number of seconds to sleep for. Parameters `$timePassed` `integer` $timePassed Returns `integer`
`private integer`	# `_throttleMessagesPerMinute( integer $timePassed )` Get a number of seconds to sleep for. Get a number of seconds to sleep for. Parameters `$timePassed` `integer` $timePassed Returns `integer`

Methods inherited from Swift_Plugins_BandwidthMonitorPlugin

bind(), commandSent(), commit(), flushBuffers(), getBytesIn(), getBytesOut(), reset(), responseReceived(), unbind(), write()

Magic methods summary

Constants summary

`integer`	`BYTES_PER_MINUTE`	`0x01`	# Flag for throttling in bytes per minute Flag for throttling in bytes per minute
`integer`	`MESSAGES_PER_MINUTE`	`0x10`	# Flag for throttling in emails per minute Flag for throttling in emails per minute

Properties summary

`private Swift_Plugins_Sleeper`	`$_sleeper`	# The Sleeper instance for sleeping. The Sleeper instance for sleeping.
`private Swift_Plugins_Timer`	`$_timer`	# The Timer instance which provides the timestamp. The Timer instance which provides the timestamp.
`private integer`	`$_start`	# The time at which the first email was sent. The time at which the first email was sent.
`private integer`	`$_rate`	# The rate at which messages should be sent. The rate at which messages should be sent.
`private integer`	`$_mode`	# The mode for throttling. This is `Swift_Plugins_ThrottlerPlugin::BYTES_PER_MINUTE` or `Swift_Plugins_ThrottlerPlugin::MESSAGES_PER_MINUTE` The mode for throttling. This is `Swift_Plugins_ThrottlerPlugin::BYTES_PER_MINUTE` or `Swift_Plugins_ThrottlerPlugin::MESSAGES_PER_MINUTE`
`private integer`	`$_messages`	# An internal counter of the number of messages sent. An internal counter of the number of messages sent.

Packages

Classes

Interfaces

Class Swift_Plugins_ThrottlerPlugin

Methods summary

Parameters

Parameters

Overrides

Parameters

Overrides

Parameters

Implementation of

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Methods inherited from Swift_Plugins_BandwidthMonitorPlugin

Magic methods summary

Constants summary

Properties summary