\Pydio\Access\Core\StreamWriteBufferStream

Provides a buffer stream that can be written to to fill a buffer, and read from to remove bytes from the buffer.

This stream returns a "hwm" metadata value that tells upstream consumers what the configured high water mark of the stream is, or the maximum preferred size of the buffer.

Summary

Methods
Properties
Constants
__construct()
getContents()
close()
write()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$bufferStream
$size
$hwm
N/A

Properties

$bufferStream

$bufferStream : \GuzzleHttp\Stream\StreamInterface

Type

\GuzzleHttp\Stream\StreamInterface

$size

$size : 

Type

$hwm

$hwm : 

Type

Methods

__construct()

__construct(\GuzzleHttp\Stream\StreamInterface  $stream, \Pydio\Access\Core\Model\AJXP_Node  $node, integer  $hwm = -1) 

Parameters

\GuzzleHttp\Stream\StreamInterface $stream
\Pydio\Access\Core\Model\AJXP_Node $node
integer $hwm

High water mark, representing the preferred maximum buffer size. If the size of the buffer exceeds the high water mark, then calls to write will continue to succeed but will return false to inform writers to slow down until the buffer has been drained by reading from it.

getContents()

getContents() : string

Returns

string

close()

close() 

write()

write(string  $string) : boolean|integer

Writes data to the buffer.

Parameters

string $string

Returns

boolean|integer