Class Swift_Transport_StreamBuffer

A generic IoBuffer implementation supporting remote sockets and local processes.

Swift_ByteStream_AbstractFilterableInputStream implements Swift_InputByteStream, Swift_Filterable

Swift_Transport_StreamBuffer implements Swift_Transport_IoBuffer

Package: Swift\Transport
Author: Chris Corbyn
Located at vendors/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` `Swift_ReplacementFilterFactory` $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` `array` $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` `string` $param `$value` `mixed` $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` `string[]` $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` `integer` $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` `integer` $length Returns `string` Throws `Swift_IoException` Implementation of `Swift_OutputByteStream::read()`
`public boolean`	# `setReadPointer( integer $byteOffset )` Not implemented Not implemented Parameters `$byteOffset` `integer` $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` `string` $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()

Magic methods summary

Constants summary

Constants inherited from Swift_Transport_IoBuffer

TYPE_PROCESS, TYPE_SOCKET

Properties summary

`private mixed`	`$_stream`	# A primary socket A primary socket
`private mixed`	`$_in`	# The input stream The input stream
`private mixed`	`$_out`	# The output stream The output stream
`private array`	`$_params`	# Buffer initialization parameters Buffer initialization parameters
`private mixed`	`$_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

Properties inherited from Swift_ByteStream_AbstractFilterableInputStream

$_sequence

Packages

Classes

Interfaces

Exceptions

Class Swift_Transport_StreamBuffer

Methods summary

Parameters

Parameters

Implementation of

Parameters

Implementation of

Implementation of

Parameters

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Methods inherited from Swift_ByteStream_AbstractFilterableInputStream

Magic methods summary

Constants summary

Constants inherited from Swift_Transport_IoBuffer

Properties summary

Properties inherited from Swift_ByteStream_AbstractFilterableInputStream