Swift_Transport_LoadBalancedTransport Class Reference

Inheritance diagram for Swift_Transport_LoadBalancedTransport:

Public Member Functions
	__construct ()
	setTransports (array $transports)
	getTransports ()
	isStarted ()
	start ()
	stop ()
	send (Swift_Mime_Message $message, &$failedRecipients=null)
	registerPlugin (Swift_Events_EventListener $plugin)

Protected Member Functions
	_getNextTransport ()
	_killCurrentTransport ()

Protected Attributes
	$_transports = array()

Private Attributes
	$_deadTransports = array()

Detailed Description

Redundantly and rotationally uses several Transports when sending.

Author

Chris Corbyn

Definition at line 16 of file Transport/LoadBalancedTransport.php.

Constructor & Destructor Documentation

__construct

(

)

Creates a new LoadBalancedTransport.

Definition at line 35 of file Transport/LoadBalancedTransport.php.

Member Function Documentation

_getNextTransport ( )

protected

Rotates the transport list around and returns the first instance.

Returns

Swift_Transport

Definition at line 144 of file Transport/LoadBalancedTransport.php.

Referenced by send().

_killCurrentTransport ( )

protected

Tag the currently used (top of stack) transport as dead/useless.

Definition at line 156 of file Transport/LoadBalancedTransport.php.

Referenced by send().

getTransports

(

)

Get $transports to delegate to.

Returns

Swift_Transport[]

Definition at line 55 of file Transport/LoadBalancedTransport.php.

isStarted

(

)

Test if this Transport mechanism has started.

Returns

bool

Implements Swift_Transport.

Definition at line 65 of file Transport/LoadBalancedTransport.php.

registerPlugin

(

Swift_Events_EventListener

$plugin

)

Register a plugin.

Parameters

Swift_Events_EventListener

$plugin

Implements Swift_Transport.

Definition at line 132 of file Transport/LoadBalancedTransport.php.

send	(	Swift_Mime_Message	$message,
		&	$failedRecipients = null
	)

Send the given Message.

Recipient/sender data will be retrieved from the Message API. The return value is the number of recipients who were accepted for delivery.

Parameters

Swift_Mime_Message	$message
	string[]	$failedRecipients An array of failures by-reference

Returns

int

Implements Swift_Transport.

Definition at line 99 of file Transport/LoadBalancedTransport.php.

References _getNextTransport(), and _killCurrentTransport().

setTransports

(

array

$transports

)

Set $transports to delegate to.

Parameters

Swift_Transport[]

$transports

Definition at line 44 of file Transport/LoadBalancedTransport.php.

Referenced by Swift_FailoverTransport\__construct(), and Swift_LoadBalancedTransport\__construct().

start

(

)

Start this Transport mechanism.

Implements Swift_Transport.

Definition at line 73 of file Transport/LoadBalancedTransport.php.

stop

(

)

Stop this Transport mechanism.

Implements Swift_Transport.

Definition at line 81 of file Transport/LoadBalancedTransport.php.

Member Data Documentation

$_deadTransports = array()

private

Definition at line 23 of file Transport/LoadBalancedTransport.php.

$_transports = array()

protected

Definition at line 30 of file Transport/LoadBalancedTransport.php.