Docs For Class Swift_Connection

Description

Swift Multi Connection

Tries to connect to a number of connections until one works successfully

author: Chris Corbyn <chris@w3style.co.uk>

Located in /Swift/Connection/Multi.php (line 20)

Swift_ConnectionBase
   |
   --Swift_Connection_Multi

Method Summary

Swift_Connection_Multi __construct ([ $connections = array()])

void addConnection ( $connection, [string $id = null])

void getAttributes ( $name)

void hasExtension ( $name)

boolean isAlive ()

void postConnect ( $instance)

string read ()

void setExtension ( $extension, [ $attributes = array()])

void start ()

void stop ()

void write (string $command, [ $end = "\r\n"])

Methods

Constructor __construct (line 36)

Constructor

Swift_Connection_Multi __construct ([ $connections = array()])

$connections

addConnection (line 48)

Add a connection to the list of options

void addConnection ( $connection, [string $id = null])

Swift_Connection $connection: An instance of the connection
string $id: An ID to assign to the connection

getAttributes (line 147)

Call the current connection's getAttributes() method

void getAttributes ( $name)

$name

Redefinition of:

Swift_ConnectionBase::getAttributes(): Get the list of attributes supported by the given extension

hasExtension (line 140)

Call the current connection's hasExtension() method

void hasExtension ( $name)

$name

Redefinition of:

Swift_ConnectionBase::hasExtension(): Check if a given extension has been set as available

isAlive (line 119)

Check if the current connection is alive

boolean isAlive ()

postConnect (line 126)

Call the current connection's postConnect() method

void postConnect ( $instance)

Swift $instance

Redefinition of:

Swift_ConnectionBase::postConnect(): Execute any needed logic after connecting and handshaking

read (line 58)

Read a full response from the buffer

throws: Swift_Connection_Exception Upon failure to read

string read ()

setExtension (line 133)

Call the current connection's setExtension() method

void setExtension ( $extension, [ $attributes = array()])

$extension
$attributes

Redefinition of:

Swift_ConnectionBase::setExtension(): Set an extension which the connection reports to support

start (line 83)

Try to start the connection

throws: Swift_Connection_Exception Upon failure to start

void start ()

stop (line 110)

Try to close the connection

throws: Swift_Connection_Exception Upon failure to close

void stop ()

write (line 71)

Write a command to the server (leave off trailing CRLF)

throws: swift_Connection_Exception Upon failure to write

void write (string $command, [ $end = "\r\n"])

string $command: The command to send
$end

Inherited Methods

Inherited From Swift_ConnectionBase

Swift_ConnectionBase::getAttributes()
Swift_ConnectionBase::hasExtension()
Swift_ConnectionBase::postConnect()
Swift_ConnectionBase::setExtension()

Class Swift_Connection_Multi

Inherited Methods