Swift_InputByteStream Interface Reference

Inheritance diagram for Swift_InputByteStream:

Public Member Functions
	write ($bytes)
	commit ()
	bind (Swift_InputByteStream $is)
	unbind (Swift_InputByteStream $is)
	flushBuffers ()

Detailed Description

An abstract means of writing data.

Classes implementing this interface may use a subsystem which requires less memory than working with large strings of data.

Author

Chris Corbyn

Definition at line 19 of file InputByteStream.php.

Member Function Documentation

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.

Parameters

Swift_InputByteStream

$is

Implemented in Swift_Signers_DKIMSigner, Swift_Signers_DomainKeySigner, Swift_ByteStream_ArrayByteStream, Swift_ByteStream_AbstractFilterableInputStream, Swift_Plugins_BandwidthMonitorPlugin, and Swift_KeyCache_SimpleKeyCacheInputStream.

Referenced by Swift_Mime_SimpleMimeEntity\_bodyToByteStream().

commit

(

)

For any bytes that are currently buffered inside the stream, force them off the buffer.

Exceptions

Swift_IoException

Implemented in Swift_Signers_DKIMSigner, Swift_Signers_DomainKeySigner, Swift_ByteStream_ArrayByteStream, Swift_ByteStream_AbstractFilterableInputStream, Swift_Plugins_BandwidthMonitorPlugin, and Swift_KeyCache_SimpleKeyCacheInputStream.

Referenced by Swift_Signers_SMimeSigner\copyFromOpenSSLOutput(), and Swift_Mime_SimpleMimeEntity\toByteStream().

flushBuffers

(

)

Flush the contents of the stream (empty it) and set the internal pointer to the beginning.

Exceptions

Swift_IoException

Implemented in Swift_Signers_DKIMSigner, Swift_Signers_DomainKeySigner, Swift_ByteStream_ArrayByteStream, Swift_ByteStream_AbstractFilterableInputStream, Swift_Plugins_BandwidthMonitorPlugin, and Swift_KeyCache_SimpleKeyCacheInputStream.

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.

Parameters

Swift_InputByteStream

$is

Implemented in Swift_Signers_DKIMSigner, Swift_Signers_DomainKeySigner, Swift_ByteStream_ArrayByteStream, Swift_ByteStream_AbstractFilterableInputStream, Swift_Plugins_BandwidthMonitorPlugin, and Swift_KeyCache_SimpleKeyCacheInputStream.

Referenced by Swift_Mime_SimpleMimeEntity\_bodyToByteStream().

write

(

$bytes

)

Writes $bytes to the end of the stream.

Writing may not happen immediately if the stream chooses to buffer. If you want to write these bytes with immediate effect, call commit() after calling write().

This method returns the sequence ID of the write (i.e. 1 for first, 2 for second, etc etc).

Parameters

string

$bytes

Exceptions

Swift_IoException

Returns

int

Implemented in Swift_Signers_DKIMSigner, Swift_Signers_DomainKeySigner, Swift_ByteStream_ArrayByteStream, Swift_ByteStream_AbstractFilterableInputStream, and Swift_Plugins_BandwidthMonitorPlugin.

Referenced by Swift_Mime_SimpleMimeEntity\_bodyToByteStream(), Swift_Signers_SMimeSigner\copyFromOpenSSLOutput(), Swift_Mime_ContentEncoder_Base64ContentEncoder\encodeByteStream(), Swift_Mime_ContentEncoder_RawContentEncoder\encodeByteStream(), Swift_Mime_ContentEncoder_NativeQpContentEncoder\encodeByteStream(), Swift_Mime_ContentEncoder_QpContentEncoder\encodeByteStream(), Swift_Mime_ContentEncoder_PlainContentEncoder\encodeByteStream(), Swift_KeyCache_ArrayKeyCache\exportToByteStream(), Swift_KeyCache_DiskKeyCache\exportToByteStream(), and Swift_Mime_SimpleMimeEntity\toByteStream().