Overview

Packages

  • CONTENIDO
  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentRssCreator
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
    • ScriptCookieDirective
  • mpAutoloaderClassMap
  • None
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SearchSolr
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob
  • Smarty
    • Cacher
    • Compiler
    • Config
    • Debug
    • PluginsBlock
    • PluginsFilter
    • PluginsFunction
    • PluginsInternal
    • PluginsModifier
    • PluginsModifierCompiler
    • PluginsShared
    • Security
    • Template
    • TemplateResources
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Transport

Classes

  • Swift_FailoverTransport
  • Swift_LoadBalancedTransport
  • Swift_MailTransport
  • Swift_Plugins_Loggers_ArrayLogger
  • Swift_Plugins_Loggers_EchoLogger
  • Swift_SendmailTransport
  • Swift_SmtpTransport
  • Swift_Transport_AbstractSmtpTransport
  • Swift_Transport_Esmtp_Auth_CramMd5Authenticator
  • Swift_Transport_Esmtp_Auth_LoginAuthenticator
  • Swift_Transport_Esmtp_Auth_PlainAuthenticator
  • Swift_Transport_Esmtp_AuthHandler
  • Swift_Transport_EsmtpTransport
  • Swift_Transport_FailoverTransport
  • Swift_Transport_LoadBalancedTransport
  • Swift_Transport_MailTransport
  • Swift_Transport_SendmailTransport
  • Swift_Transport_SimpleMailInvoker
  • Swift_Transport_StreamBuffer

Interfaces

  • Swift_Plugins_Logger
  • Swift_Plugins_Pop_Pop3Exception
  • Swift_Transport
  • Swift_Transport_Esmtp_Authenticator
  • Swift_Transport_EsmtpHandler
  • Swift_Transport_IoBuffer
  • Swift_Transport_MailInvoker
  • Swift_Transport_SmtpAgent
  • Swift_TransportException
  • Overview
  • Package
  • Class
  • Todo
  • Download

Class Swift_Transport_StreamBuffer

A generic IoBuffer implementation supporting remote sockets and local processes.

Swift_ByteStream_AbstractFilterableInputStream implements Swift_InputByteStream, Swift_Filterable
Extended by Swift_Transport_StreamBuffer implements Swift_Transport_IoBuffer
Package: Swift\Transport
Author: Chris Corbyn
Located at classes/swiftmailer/lib/classes/Swift/Transport/StreamBuffer.php
Methods summary
public
# __construct( Swift_ReplacementFilterFactory $replacementFactory )

Create a new StreamBuffer using $replacementFactory for transformations.

Create a new StreamBuffer using $replacementFactory for transformations.

Parameters

$replacementFactory
public
# initialize( array $params )

Perform any initialization needed, using the given $params. Parameters will vary depending upon the type of IoBuffer used.

Perform any initialization needed, using the given $params. Parameters will vary depending upon the type of IoBuffer used.

Parameters

$params

Implementation of

Swift_Transport_IoBuffer::initialize()
public
# setParam( string $param, mixed $value )

Set an individual param on the buffer (e.g. switching to SSL).

Set an individual param on the buffer (e.g. switching to SSL).

Parameters

$param
$value

Implementation of

Swift_Transport_IoBuffer::setParam()
public
# startTLS( )
public
# terminate( )

Perform any shutdown logic needed.

Perform any shutdown logic needed.

Implementation of

Swift_Transport_IoBuffer::terminate()
public
# setWriteTranslations( array $replacements )

Set an array of string replacements which should be made on data written to the buffer. This could replace LF with CRLF for example.

Set an array of string replacements which should be made on data written to the buffer. This could replace LF with CRLF for example.

Parameters

$replacements

Implementation of

Swift_Transport_IoBuffer::setWriteTranslations()
public string
# readLine( integer $sequence )

Get a line of output (including any CRLF). The $sequence number comes from any writes and may or may not be used depending upon the implementation.

Get a line of output (including any CRLF). The $sequence number comes from any writes and may or may not be used depending upon the implementation.

Parameters

$sequence
of last write to scan from

Returns

string

Implementation of

Swift_Transport_IoBuffer::readLine()
public string
# read( integer $length )

Reads $length bytes from the stream into a string and moves the pointer through the stream by $length. If less bytes exist than are requested the remaining bytes are given instead. If no bytes are remaining at all, boolean false is returned.

Reads $length bytes from the stream into a string and moves the pointer through the stream by $length. If less bytes exist than are requested the remaining bytes are given instead. If no bytes are remaining at all, boolean false is returned.

Parameters

$length

Returns

string

Throws

Swift_IoException

Implementation of

Swift_OutputByteStream::read()
public boolean
# setReadPointer( integer $byteOffset )

Not implemented

Not implemented

Parameters

$byteOffset

Returns

boolean

Throws

Swift_IoException

Implementation of

Swift_OutputByteStream::setReadPointer()
protected
# _flush( )

Flush the stream contents

Flush the stream contents

protected
# _commit( string $bytes )

Write this bytes to the stream

Write this bytes to the stream

Parameters

$bytes
private
# _establishSocketConnection( )

Establishes a connection to a remote server.

Establishes a connection to a remote server.

private
# _establishProcessConnection( )

Opens a process for input/output.

Opens a process for input/output.

private
# _getReadConnectionDescription( )
Methods inherited from Swift_ByteStream_AbstractFilterableInputStream
addFilter(), bind(), commit(), flushBuffers(), removeFilter(), unbind(), write()
Constants inherited from Swift_Transport_IoBuffer
TYPE_PROCESS, TYPE_SOCKET
Properties summary
private $_stream

A primary socket

A primary socket

#
private $_in

The input stream

The input stream

#
private $_out

The output stream

The output stream

#
private array $_params

Buffer initialization parameters

Buffer initialization parameters

# array()
private $_replacementFactory

The ReplacementFilterFactory

The ReplacementFilterFactory

#
private array $_translations

Translations performed on data being streamed into the buffer

Translations performed on data being streamed into the buffer

# array()
Properties inherited from Swift_ByteStream_AbstractFilterableInputStream
$_sequence
CMS CONTENIDO 4.9.7 API documentation generated by ApiGen