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

Class: Swift_Plugins_BandwidthMonitorPlugin

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Plugins/BandwidthMonitorPlugin.php

Class Overview


Reduces network flooding when sending large amounts of mail.


Author(s):

  • Chris Corbyn

Implements interfaces:

Methods


Child classes:

Swift_Plugins_ThrottlerPlugin
Throttles the rate at which emails are sent.

Class Details

[line 16]
Reduces network flooding when sending large amounts of mail.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


method beforeSendPerformed [line 38]

void beforeSendPerformed( Swift_Events_SendEvent $evt)

Not used.



Tags:

access:  public


Overridden in child classes as:

Swift_Plugins_ThrottlerPlugin::beforeSendPerformed()
Invoked immediately before the Message is sent.


Implementation of:
Swift_Events_SendListener::beforeSendPerformed()
Invoked immediately before the Message is sent.

Parameters:

Swift_Events_SendEvent   $evt  

[ Top ]

method bind [line 103]

void bind( Swift_InputByteStream $is)

Attach $is to this stream.

The stream acts as an observer, receiving all data that is written. All write() and flushBuffers() operations will be mirrored.




Tags:

access:  public



Implementation of:
Swift_InputByteStream::bind()
Attach $is to this stream.

Parameters:

Swift_InputByteStream   $is  

[ Top ]

method commandSent [line 58]

void commandSent( Swift_Events_CommandEvent $evt)

Invoked immediately following a command being sent.



Tags:

access:  public



Implementation of:
Swift_Events_CommandListener::commandSent()
Invoked immediately following a command being sent.

Parameters:


[ Top ]

method commit [line 91]

void commit( )

Not used.



Tags:

access:  public



Implementation of:
Swift_InputByteStream::commit()
For any bytes that are currently buffered inside the stream, force them off the buffer.
[ Top ]

method flushBuffers [line 129]

void flushBuffers( )

Not used.



Tags:

access:  public



Implementation of:
Swift_InputByteStream::flushBuffers()
Flush the contents of the stream (empty it) and set the internal pointer to the beginning.
[ Top ]

method getBytesIn [line 151]

int getBytesIn( )

Get the total number of bytes received from the server.



Tags:

access:  public


[ Top ]

method getBytesOut [line 141]

int getBytesOut( )

Get the total number of bytes sent to the server.



Tags:

access:  public


[ Top ]

method reset [line 159]

void reset( )

Reset the internal counters to zero.



Tags:

access:  public


[ Top ]

method responseReceived [line 69]

void responseReceived( Swift_Events_ResponseEvent $evt)

Invoked immediately following a response coming back.



Tags:

access:  public



Implementation of:
Swift_Events_ResponseListener::responseReceived()
Invoked immediately following a response coming back.

Parameters:


[ Top ]

method sendPerformed [line 47]

void sendPerformed( Swift_Events_SendEvent $evt)

Invoked immediately after the Message is sent.



Tags:

access:  public


Overridden in child classes as:

Swift_Plugins_ThrottlerPlugin::sendPerformed()
Invoked when a Message is sent.


Implementation of:
Swift_Events_SendListener::sendPerformed()
Invoked immediately after the Message is sent.

Parameters:

Swift_Events_SendEvent   $evt  

[ Top ]

method unbind [line 117]

void unbind( Swift_InputByteStream $is)

Remove an already bound stream.

If $is is not bound, no errors will be raised. If the stream currently has any buffered data it will be written to $is before unbinding occurs.




Tags:

access:  public



Implementation of:
Swift_InputByteStream::unbind()
Remove an already bound stream.

Parameters:

Swift_InputByteStream   $is  

[ Top ]

method write [line 80]

void write( string $bytes)

Called when a message is sent so that the outgoing counter can be increased.



Tags:

access:  public



Implementation of:
Swift_InputByteStream::write()
Writes $bytes to the end of the stream.

Parameters:

string   $bytes  

[ Top ]


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