PHP Interface Swift_InputByteStream, Halite

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

Author: Chris Corbyn

Show file Open project: HaliteChallenge/Halite Interface Usage Examples

Public Methods

Method	Description
bind ( Swift_InputByteStream $is )	Attach $is to this stream.
commit ( )	For any bytes that are currently buffered inside the stream, force them off the buffer.
flushBuffers ( )	Flush the contents of the stream (empty it) and set the internal pointer to the beginning.
unbind ( Swift_InputByteStream $is )	Remove an already bound stream.
write ( string $bytes ) : integer	Writes $bytes to the end of the stream.

Method Details

bind() public method

The stream acts as an observer, receiving all data that is written. All {@link write()} and {@link flushBuffers()} operations will be mirrored.

public bind ( Swift_InputByteStream $is )
$is	Swift_InputByteStream

commit() public method

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

public commit ( )

flushBuffers() public method

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

public flushBuffers ( )

unbind() public method

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.

public unbind ( Swift_InputByteStream $is )
$is	Swift_InputByteStream

write() public method

Writing may not happen immediately if the stream chooses to buffer. If you want to write these bytes with immediate effect, call {@link commit()} after calling write(). This method returns the sequence ID of the write (i.e. 1 for first, 2 for second, etc etc).

public write ( string $bytes ) : integer
$bytes	string
return	integer