Class Swift_Plugins_BandwidthMonitorPlugin

Reduces network flooding when sending large amounts of mail.

Swift_Plugins_BandwidthMonitorPlugin implements Swift_Events_SendListener, Swift_Events_CommandListener, Swift_Events_ResponseListener, Swift_InputByteStream

Direct known subclasses

Swift_Plugins_ThrottlerPlugin

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

Methods summary

`public`	# `beforeSendPerformed( Swift_Events_SendEvent $evt )` Not used. Not used. Parameters `$evt` `Swift_Events_SendEvent` $evt Implementation of `Swift_Events_SendListener::beforeSendPerformed()`
`public`	# `sendPerformed( Swift_Events_SendEvent $evt )` Invoked immediately after the Message is sent. Invoked immediately after the Message is sent. Parameters `$evt` `Swift_Events_SendEvent` $evt Implementation of `Swift_Events_SendListener::sendPerformed()`
`public`	# `commandSent( Swift_Events_CommandEvent $evt )` Invoked immediately following a command being sent. Invoked immediately following a command being sent. Parameters `$evt` `Swift_Events_ResponseEvent` $evt Implementation of `Swift_Events_CommandListener::commandSent()`
`public`	# `responseReceived( Swift_Events_ResponseEvent $evt )` Invoked immediately following a response coming back. Invoked immediately following a response coming back. Parameters `$evt` `Swift_Events_ResponseEvent` $evt Implementation of `Swift_Events_ResponseListener::responseReceived()`
`public integer`	# `write( string $bytes )` Called when a message is sent so that the outgoing counter can be increased. Called when a message is sent so that the outgoing counter can be increased. Parameters `$bytes` `string` $bytes Returns `integer` Throws `Swift_IoException` Implementation of `Swift_InputByteStream::write()`
`public`	# `commit( )` Not used. Not used. Throws `Swift_IoException` Implementation of `Swift_InputByteStream::commit()`
`public`	# `bind( Swift_InputByteStream $is )` Attach $is to this stream. The stream acts as an observer, receiving all data that is written. All `Swift_Plugins_BandwidthMonitorPlugin::write()` and `Swift_Plugins_BandwidthMonitorPlugin::flushBuffers()` operations will be mirrored. Attach $is to this stream. The stream acts as an observer, receiving all data that is written. All `Swift_Plugins_BandwidthMonitorPlugin::write()` and `Swift_Plugins_BandwidthMonitorPlugin::flushBuffers()` operations will be mirrored. Parameters `$is` `Swift_InputByteStream` $is Implementation of `Swift_InputByteStream::bind()`
`public`	# `unbind( Swift_InputByteStream $is )` Remove an already bound stream. If $is is not bound, no errors will be raised. If the stream currently has any buffered data it will be written to $is before unbinding occurs. Remove an already bound stream. If $is is not bound, no errors will be raised. If the stream currently has any buffered data it will be written to $is before unbinding occurs. Parameters `$is` `Swift_InputByteStream` $is Implementation of `Swift_InputByteStream::unbind()`
`public`	# `flushBuffers( )` Not used. Not used. Throws `Swift_IoException` Implementation of `Swift_InputByteStream::flushBuffers()`
`public integer`	# `getBytesOut( )` Get the total number of bytes sent to the server. Get the total number of bytes sent to the server. Returns `integer`
`public integer`	# `getBytesIn( )` Get the total number of bytes received from the server. Get the total number of bytes received from the server. Returns `integer`
`public`	# `reset( )` Reset the internal counters to zero. Reset the internal counters to zero.

Magic methods summary

Properties summary

`private integer`	`$_out`	# The outgoing traffic counter. The outgoing traffic counter.
`private integer`	`$_in`	# The incoming traffic counter. The incoming traffic counter.
`private array`	`$_mirrors`	# Bound byte streams Bound byte streams

Packages

Classes

Interfaces

Class Swift_Plugins_BandwidthMonitorPlugin

Direct known subclasses

Methods summary

Parameters

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Returns

Throws

Implementation of

Throws

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Throws

Implementation of

Returns

Returns

Magic methods summary

Properties summary