Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Swift_Plugins_AntiFloodPlugin

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Plugins/AntiFloodPlugin.php

Class Overview


Reduces network flooding when sending large amounts of mail.


Author(s):

  • Chris Corbyn

Implements interfaces:

Methods



Class Details

[line 16]
Reduces network flooding when sending large amounts of mail.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


constructor __construct [line 53]

Swift_Plugins_AntiFloodPlugin __construct( [int $threshold = 99], [int $sleep = 0], [Swift_Plugins_Sleeper $sleeper = null])

Create a new AntiFloodPlugin with $threshold and $sleep time.



Tags:

access:  public


Parameters:

int   $threshold  
int   $sleep   time
Swift_Plugins_Sleeper   $sleeper   (not needed really)

[ Top ]

method beforeSendPerformed [line 105]

void beforeSendPerformed( Swift_Events_SendEvent $evt)

Invoked immediately before the Message is sent.



Tags:

access:  public



Implementation of:
Swift_Events_SendListener::beforeSendPerformed()
Invoked immediately before the Message is sent.

Parameters:

Swift_Events_SendEvent   $evt  

[ Top ]

method getSleepTime [line 95]

int getSleepTime( )

Get the number of seconds to sleep for during a restart.



Tags:

access:  public


[ Top ]

method getThreshold [line 75]

int getThreshold( )

Get the number of emails to send before restarting.



Tags:

access:  public


[ Top ]

method sendPerformed [line 114]

void sendPerformed( Swift_Events_SendEvent $evt)

Invoked immediately after the Message is sent.



Tags:

access:  public



Implementation of:
Swift_Events_SendListener::sendPerformed()
Invoked immediately after the Message is sent.

Parameters:

Swift_Events_SendEvent   $evt  

[ Top ]

method setSleepTime [line 85]

void setSleepTime( int $sleep)

Set the number of seconds to sleep for during a restart.



Tags:

access:  public


Parameters:

int   $sleep   time

[ Top ]

method setThreshold [line 65]

void setThreshold( int $threshold)

Set the number of emails to send before restarting.



Tags:

access:  public


Parameters:

int   $threshold  

[ Top ]

method sleep [line 133]

void sleep( int $seconds)

Sleep for $seconds.



Tags:

access:  public



Implementation of:
Swift_Plugins_Sleeper::sleep()
Sleep for $seconds.

Parameters:

int   $seconds  

[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:43:23 +0000 by phpDocumentor 1.4.3