Swift_Transport_FailoverTransport Class Reference

Inheritance diagram for Swift_Transport_FailoverTransport:

Public Member Functions
	__construct ()
	send (Swift_Mime_Message $message, &$failedRecipients=null)
Public Member Functions inherited from Swift_Transport_LoadBalancedTransport
	__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 Member Functions inherited from Swift_Transport_LoadBalancedTransport
	_getNextTransport ()
	_killCurrentTransport ()

Private Attributes
	$_currentTransport

Additional Inherited Members
Protected Attributes inherited from Swift_Transport_LoadBalancedTransport
	$_transports = array()

Detailed Description

Contains a list of redundant Transports so when one fails, the next is used.

Author

Chris Corbyn

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

Constructor & Destructor Documentation

__construct

(

)

Creates a new FailoverTransport.

Definition at line 28 of file Transport/FailoverTransport.php.

Member Function Documentation

_getNextTransport ( )

protected

Definition at line 71 of file Transport/FailoverTransport.php.

References $_currentTransport.

Referenced by send().

_killCurrentTransport ( )

protected

Definition at line 80 of file Transport/FailoverTransport.php.

Referenced by send().

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 44 of file Transport/FailoverTransport.php.

References _getNextTransport(), and _killCurrentTransport().

Member Data Documentation

$_currentTransport

private

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

Referenced by _getNextTransport().