Class Swift_Transport_FailoverTransport
Inheritance | Swift_Transport_FailoverTransport » Swift_Transport_LoadBalancedTransport |
---|---|
Implements | Swift_Transport |
Subclasses | Swift_FailoverTransport |
Contains a list of redundant Transports so when one fails, the next is used.
Protected Properties
Property | Type | Description | Defined By |
---|---|---|---|
$_transports | Swift_Transport[] | Swift_Transport_LoadBalancedTransport |
Public Methods
Method | Description | Defined By |
---|---|---|
__construct() | Creates a new FailoverTransport. | Swift_Transport_FailoverTransport |
getTransports() | Get $transports to delegate to. | Swift_Transport_LoadBalancedTransport |
isStarted() | Test if this Transport mechanism has started. | Swift_Transport_LoadBalancedTransport |
registerPlugin() | Register a plugin. | Swift_Transport_LoadBalancedTransport |
send() | Send the given Message. | Swift_Transport_FailoverTransport |
setTransports() | Set $transports to delegate to. | Swift_Transport_LoadBalancedTransport |
start() | Start this Transport mechanism. | Swift_Transport_LoadBalancedTransport |
stop() | Stop this Transport mechanism. | Swift_Transport_LoadBalancedTransport |
Protected Methods
Method | Description | Defined By |
---|---|---|
_getNextTransport() | Swift_Transport_FailoverTransport | |
_killCurrentTransport() | Swift_Transport_FailoverTransport |
Method Details
Creates a new FailoverTransport.
public void __construct ( ) |
protected void _getNextTransport ( ) |
protected void _killCurrentTransport ( ) |
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.
public int send ( Swift_Mime_Message $message, <b>&</b>$failedRecipients = null ) | ||
$message | Swift_Mime_Message | |
$failedRecipients | string[] | An array of failures by-reference |