Class Swift_Plugin_AntiFlood

Description
Description | Methods (details)

Swift AntiFlood controller.

Closes a connection and pauses for X seconds after a number of emails have been sent.

Located in /Swift/Plugin/AntiFlood.php (line 20) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

																																																												
												

											Swift_Plugin_AntiFlood
										__construct
											(int $threshold, [int $wait = 0])
									

																

											int
										getThreshold
										()
									

																

											int
										getWait
										()
									

																

											void
										sendPerformed
											( $e)
									

																

											void
										setThreshold
											(int $threshold)
									

																

											void
										setWait
											(int $time)
									

																

											void
										wait
											(int $seconds)
									

								

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			




	
	

		Constructor __construct (line 43)
	
 
	
	

Constructor

	
	

		Swift_Plugin_AntiFlood
		
			__construct
		
					(int $threshold, int $wait)
			

	
			
    
					
  • 
				int
				$threshold: Number of emails to send before re-connecting			
    • 
					
  • 
				int
				$wait: The timeout in seconds between connections			
    • 
				

		
			
	




	
	

		getThreshold (line 60)
	
 
	
	

Get the number of emails which need to be sent for reconnection to occur

	
	

		int
		
			getThreshold
		
				()
			

	
		
			
	




	
	

		getWait (line 76)
	
 
	
	

Get the number of seconds the plugin should wait for before re-connecting

	
	

		int
		
			getWait
		
				()
			

	
		
			
	




	
	

		sendPerformed (line 94)
	
 
	
	

Swift's SendEvent listener.


Invoked when Swift sends a message

	
    
				
  • throws: Swift_Connection_Exception If the connection cannot be closed/re-opened
    • 
			

	
	

		void
		
			sendPerformed
		
					( $e)
			

	
			
		
			
	




	
	

		setThreshold (line 52)
	
 
	
	

Set the number of emails which must be sent for a reconnection to occur

	
	

		void
		
			setThreshold
		
					(int $threshold)
			

	
			
    
					
  • 
				int
				$threshold: Number of emails			
    • 
				

		
			
	




	
	

		setWait (line 68)
	
 
	
	

Set the number of seconds the plugin should wait for before reconnecting

	
	

		void
		
			setWait
		
					(int $time)
			

	
			
    
					
  • 
				int
				$time: Time in seconds			
    • 
				

		
			
	




	
	

		wait (line 84)
	
 
	
	

Sleep for a given number of seconds

	
	

		void
		
			wait
		
					(int $seconds)
			

	
			
    
					
  • 
				int
				$seconds: Number of seconds to wait for			
    • 
				

		
			
	

						
		

	



	

		Documentation generated on Tue, 06 Mar 2007 23:32:20 +0000 by phpDocumentor 1.3.1