Class: Swift_Transport_StreamBuffer

Swift_Transport_StreamBuffer __construct( Swift_ReplacementFilterFactory $replacementFactory)

Create a new StreamBuffer using $replacementFactory for transformations.

Tags:

Parameters:

void initialize( $params)

Perform any initialization needed, using the given $params.

Parameters will vary depending upon the type of IoBuffer used.

Tags:

---

Swift_Transport_IoBuffer::initialize()

Perform any initialization needed, using the given $params.

Parameters:

string read( int $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.

Tags:

Parameters:

string readLine( int $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.

Tags:

---

Swift_Transport_IoBuffer::readLine()

Get a line of output (including any CRLF).

Parameters:

void setParam( string $param, mixed $value)

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

Tags:

---

Swift_Transport_IoBuffer::setParam()

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

Parameters:

void setReadPointer( $byteOffset)

Not implemented

Tags:

Parameters:

void setWriteTranslations( $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.

Tags:

---

Swift_Transport_IoBuffer::setWriteTranslations()

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:

void terminate( )

Perform any shutdown logic needed.

Tags:

---

Swift_Transport_IoBuffer::terminate()

Perform any shutdown logic needed.

void _commit( $bytes)

Write this bytes to the stream

Tags:

Overrides Swift_ByteStream_AbstractFilterableInputStream::_commit() (Commit the given bytes to the storage medium immediately.)

Parameters:

void _flush( )

Flush the stream contents

Tags:

Overrides Swift_ByteStream_AbstractFilterableInputStream::_flush() (Flush any buffers/content with immediate effect.)