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

Class: Swift_Transport_FailoverTransport

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Transport/FailoverTransport.php

Class Overview

Swift_Transport_LoadBalancedTransport
   |
   --Swift_Transport_FailoverTransport

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


Author(s):

  • Chris Corbyn

Methods


Child classes:

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

Inherited Variables

Inherited Methods

Class: Swift_Transport_LoadBalancedTransport

Swift_Transport_LoadBalancedTransport::__construct()
Swift_Transport_LoadBalancedTransport::getLastUsedTransport()
Get the Transport used in the last successful send operation.
Swift_Transport_LoadBalancedTransport::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_LoadBalancedTransport::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::_getNextTransport()
Rotates the transport list around and returns the first instance.
Swift_Transport_LoadBalancedTransport::_killCurrentTransport()
Tag the currently used (top of stack) transport as dead/useless.

Class Details

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



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


constructor __construct [line 26]

Swift_Transport_FailoverTransport __construct( )



Tags:

access:  public


Overridden in child classes as:

Swift_FailoverTransport::__construct()
Creates a new FailoverTransport with $transports.

Overrides Swift_Transport_LoadBalancedTransport::__construct() (parent method not documented)

[ Top ]

method send [line 42]

int send( Swift_Mime_Message $message, [ &$failedRecipients = null], string[] $failedRecipients)

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.




Tags:

access:  public


Overrides Swift_Transport_LoadBalancedTransport::send() (Send the given Message.)

Parameters:

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

[ Top ]

method _getNextTransport [line 74]

void _getNextTransport( )



Tags:

access:  protected


Overrides Swift_Transport_LoadBalancedTransport::_getNextTransport() (Rotates the transport list around and returns the first instance.)

[ Top ]

method _killCurrentTransport [line 83]

void _killCurrentTransport( )



Tags:

access:  protected


Overrides Swift_Transport_LoadBalancedTransport::_killCurrentTransport() (Tag the currently used (top of stack) transport as dead/useless.)

[ Top ]


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