Overview

Packages

  • akismet
  • None
  • PHP
  • Smarty
    • Cacher
    • Compiler
    • Config
    • Debug
    • plugins
    • PluginsBlock
    • PluginsFilter
    • PluginsFunction
    • PluginsInternal
    • PluginsModifier
    • PluginsModifierCompiler
    • PluginsShared
    • Security
    • Template
    • TemplateResources
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Signatures
    • Signed
    • Transport
  • wa-apps
    • blog
      • actions
        • backend
        • blog
        • comment
        • cron
        • design
        • frontend
        • page
        • plugin
        • post
      • api
        • v1
      • cli
      • layout
      • model
      • plugin
        • aksimet
        • category
        • emailsubscription
        • favorite
        • gravatar
        • import
        • markdown
        • myposts
        • tag
        • troll
      • settings
    • checklists
      • backend
      • json
    • contacts
      • backend
    • developer
    • dummy
    • guestbook
    • guestbook2
    • photos
      • album
      • api
        • v1
      • backend
      • design
      • dialog
      • frontend
      • page
      • photo
      • plugin
        • comment
        • imageeffects
        • import
        • publicgallery
        • watermark
      • search
      • settings
      • stack
      • tag
      • upload
    • site
      • backend
      • blocks
      • config
      • design
      • domains
      • files
      • frontend
      • helper
      • layout
      • pages
      • routing
      • setting
    • stickies
      • api
        • v1
      • sheet
      • stiky
  • wa-plugin
    • payment
    • shipping
    • sms
  • wa-plugins
    • shipping
      • usps
  • wa-system
    • API
    • Auth
      • Adapters
    • Autoload
    • Cache
      • Adapter
    • Captcha
    • Config
    • Contact
    • controller
    • currency
    • database
    • datetime
    • design
    • event
    • exception
    • files
    • image
    • layout
    • locale
    • log
    • mail
    • page
      • action
      • model
    • payment
    • plugin
    • request
    • response
    • routing
    • shipping
    • sms
    • storage
    • user
    • util
    • validator
    • view
    • webasyst
      • api
      • backend
      • cli
      • config
      • layout
      • login
      • model
      • password
      • payment
      • profile
      • settings
      • shipment
    • widget
    • workflow
  • waPlugins
    • Payment
  • webasyst
    • wa-system
      • helper

Classes

  • Swift_Plugins_AntiFloodPlugin
  • Swift_Plugins_BandwidthMonitorPlugin
  • Swift_Plugins_DecoratorPlugin
  • Swift_Plugins_ImpersonatePlugin
  • Swift_Plugins_LoggerPlugin
  • Swift_Plugins_MessageLogger
  • Swift_Plugins_PopBeforeSmtpPlugin
  • Swift_Plugins_RedirectingPlugin
  • Swift_Plugins_ReporterPlugin
  • Swift_Plugins_Reporters_HitReporter
  • Swift_Plugins_Reporters_HtmlReporter
  • Swift_Plugins_ThrottlerPlugin

Interfaces

  • Swift_Plugins_Decorator_Replacements
  • Swift_Plugins_Pop_Pop3Connection
  • Swift_Plugins_Reporter
  • Swift_Plugins_Sleeper
  • Swift_Plugins_Timer
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

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 wa-system/vendors/swift/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_CommandEvent
$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.

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.

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.

Properties summary
private integer $_out 0
#

The outgoing traffic counter.

The outgoing traffic counter.

private integer $_in 0
#

The incoming traffic counter.

The incoming traffic counter.

private array $_mirrors array()
#

Bound byte streams

Bound byte streams

My fork of Webasyst Framework API documentation generated by ApiGen 2.8.0