Docs For Class Swift_Transport_LoadBalancedTransport

Swift_Transport_LoadBalancedTransport __construct(
)

Creates a new LoadBalancedTransport.

Tags:

access:

public

Overridden in child classes as:

Swift_Transport_FailoverTransport::__construct(): Creates a new FailoverTransport.

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

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

[ Top ]

array getTransports(

$transports)

Get $transports to delegate to.

Tags:

return:	Swift_Transport
access:	public

Parameters:

array

$transports

[ Top ]

boolean isStarted(
)

Test if this Transport mechanism has started.

Tags:

access:

public

Implementation of:

Swift_Transport::isStarted(): Test if this Transport mechanism has started.

[ Top ]

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 ]

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

Send the given Message.

Recipient/sender data will be retreived 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	to collect failures by-reference

[ Top ]

void setTransports(

$transports)

Set $transports to delegate to.

Tags:

access:

public

Parameters:

array

$transports

Swift_Transport

[ Top ]

void start(
)

Start this Transport mechanism.

Tags:

access:

public

Implementation of:

Swift_Transport::start(): Start this Transport mechanism.

[ Top ]

void stop(
)

Stop this Transport mechanism.

Tags:

access:

public

Implementation of:

Swift_Transport::stop(): Stop this Transport mechanism.

[ Top ]

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 ]

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 ]

Class: Swift_Transport_LoadBalancedTransport

Class Overview

Author(s):

Variables

Methods

Child classes:

Class Details

Tags:

Class Variables

$_transports = array()

Tags:

Class Methods

constructor __construct [line 39]

Tags:

method getTransports [line 59]

Tags:

Parameters:

method isStarted [line 69]

Tags:

method registerPlugin [line 143]

Tags:

Parameters:

method send [line 103]

Tags:

Parameters:

method setTransports [line 48]

Tags:

Parameters:

method start [line 77]

Tags:

method stop [line 85]

Tags:

method _getNextTransport [line 159]

Tags:

method _killCurrentTransport [line 173]

Tags: