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

Class: Swift_Transport_LoadBalancedTransport

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

Class Overview


Redundantly and rotationally uses several Transports when sending.


Author(s):

  • Chris Corbyn

Implements interfaces:

Variables

Methods


Child classes:

Swift_LoadBalancedTransport
Redundantly and rotationally uses several Transport implementations when sending.
Swift_Transport_FailoverTransport
Contains a list of redundant Transports so when one fails, the next is used.

Class Details

[line 16]
Redundantly and rotationally uses several Transports when sending.



Tags:

author:  Chris Corbyn


[ Top ]


Class Variables

$_lastUsedTransport =  null

[line 37]

The Transport used in the last successful send operation.



Tags:

access:  protected

Type:   Swift_Transport


[ Top ]

$_transports = array()

[line 30]

The Transports which are used in rotation.



Tags:

access:  protected

Type:   Swift_Transport[]


[ Top ]



Class Methods


constructor __construct [line 40]

Swift_Transport_LoadBalancedTransport __construct( )



Tags:

access:  public


Overridden in child classes as:

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

[ Top ]

method getLastUsedTransport [line 70]

Swift_Transport getLastUsedTransport( )

Get the Transport used in the last successful send operation.



Tags:

access:  public


[ Top ]

method getTransports [line 60]

Swift_Transport[] getTransports( )

Get $transports to delegate to.



Tags:

access:  public


[ Top ]

method isStarted [line 80]

bool isStarted( )

Test if this Transport mechanism has started.



Tags:

access:  public



Implementation of:
Swift_Transport::isStarted()
Test if this Transport mechanism has started.
[ Top ]

method registerPlugin [line 149]

void registerPlugin( Swift_Events_EventListener $plugin)

Register a plugin.



Tags:

access:  public



Implementation of:
Swift_Transport::registerPlugin()
Register a plugin in the Transport.

Parameters:

Swift_Events_EventListener   $plugin  

[ Top ]

method send [line 114]

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


Overridden in child classes as:

Swift_Transport_FailoverTransport::send()
Send the given Message.


Implementation of:
Swift_Transport::send()
Send the given Message.

Parameters:

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

[ Top ]

method setTransports [line 49]

void setTransports( $transports)

Set $transports to delegate to.



Tags:

access:  public


Parameters:

Swift_Transport[]   $transports  

[ Top ]

method start [line 88]

void start( )

Start this Transport mechanism.



Tags:

access:  public



Implementation of:
Swift_Transport::start()
Start this Transport mechanism.
[ Top ]

method stop [line 96]

void stop( )

Stop this Transport mechanism.



Tags:

access:  public



Implementation of:
Swift_Transport::stop()
Stop this Transport mechanism.
[ Top ]

method _getNextTransport [line 161]

Swift_Transport _getNextTransport( )

Rotates the transport list around and returns the first instance.



Tags:

access:  protected


Overridden in child classes as:

Swift_Transport_FailoverTransport::_getNextTransport()

[ Top ]

method _killCurrentTransport [line 173]

void _killCurrentTransport( )

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



Tags:

access:  protected


Overridden in child classes as:

Swift_Transport_FailoverTransport::_killCurrentTransport()

[ Top ]


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