Swift_Transport_IoBuffer Interface Reference

Inheritance diagram for Swift_Transport_IoBuffer:

Public Member Functions
	initialize (array $params)
	setParam ($param, $value)
	terminate ()
	setWriteTranslations (array $replacements)
	readLine ($sequence)
Public Member Functions inherited from Swift_InputByteStream
	write ($bytes)
	commit ()
	bind (Swift_InputByteStream $is)
	unbind (Swift_InputByteStream $is)
	flushBuffers ()
Public Member Functions inherited from Swift_OutputByteStream
	read ($length)
	setReadPointer ($byteOffset)

Public Attributes
const	TYPE_SOCKET = 0x0001
const	TYPE_PROCESS = 0x0010

Detailed Description

Buffers input and output to a resource.

Author

Chris Corbyn

Definition at line 16 of file IoBuffer.php.

Member Function Documentation

initialize

(

array

$params

)

Perform any initialization needed, using the given $params.

Parameters will vary depending upon the type of IoBuffer used.

Parameters

array

$params

Implemented in Swift_Transport_StreamBuffer.

readLine

(

$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.

Parameters

int

$sequence

of last write to scan from

Returns

string

Implemented in Swift_Transport_StreamBuffer.

setParam	(		$param,
			$value
	)

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

Parameters

string	$param
mixed	$value

Implemented in Swift_Transport_StreamBuffer.

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.

Parameters

string[]

$replacements

Implemented in Swift_Transport_StreamBuffer.

terminate

(

)

Perform any shutdown logic needed.

Implemented in Swift_Transport_StreamBuffer.

Member Data Documentation

const TYPE_PROCESS = 0x0010

A process buffer with I/O support

Definition at line 22 of file IoBuffer.php.

const TYPE_SOCKET = 0x0001

A socket buffer over TCP

Definition at line 19 of file IoBuffer.php.