Use constructor parameter instead of public $softLimit property

Author: clue

README.md

@@ -820,11 +820,14 @@ ready to accept data.
 For this, it uses an in-memory buffer string to collect all outstanding writes.
 This buffer has a soft-limit applied which defines how much data it is willing
 to accept before the caller SHOULD stop sending further data.
-It currently defaults to 64 KiB and can be controlled through the public
-`$softLimit` property like this:
+
+This class takes an optional `int|null $writeBufferSoftLimit` parameter that controls
+this maximum buffer size in bytes.
+You can use a `null` value here in order to apply its default value.
+This value SHOULD NOT be changed unless you know what you're doing.
 
 ```php
-$stream->softLimit = 8192;
+$stream = new WritableResourceStream(STDOUT, $loop, 8192);
 ```
 
 See also [`write()`](#write) for more details.
@@ -899,15 +902,22 @@ ready to accept data.
 For this, it uses an in-memory buffer string to collect all outstanding writes.
 This buffer has a soft-limit applied which defines how much data it is willing
 to accept before the caller SHOULD stop sending further data.
-It currently defaults to 64 KiB and can be controlled through the public
-`$softLimit` property like this:
+
+This class takes another optional `WritableStreamInterface|null $buffer` parameter
+that controls this write behavior of this stream.
+You can use a `null` value here in order to apply its default value.
+This value SHOULD NOT be changed unless you know what you're doing.
+
+If you want to change the write buffer soft limit, you can pass an instance of
+[`WritableResourceStream`](#writableresourcestream) like this:
 
 ```php
-$buffer = $stream->getBuffer();
-$buffer->softLimit = 8192;
+$conn = stream_socket_client('tcp://google.com:80');
+$buffer = new WritableResourceStream($conn, $loop, 8192);
+$stream = new DuplexResourceStream($conn, $loop, null, $buffer);
 ```
 
-See also [`write()`](#write) for more details.
+See also [`WritableResourceStream`](#writableresourcestream) for more details.
 
 ### ThroughStream
 

src/DuplexResourceStream.php

@@ -196,14 +196,6 @@ public function handleClose()
         }
     }
 
-    /**
-     * @return WritableStreamInterface
-     */
-    public function getBuffer()
-    {
-        return $this->buffer;
-    }
-
     /**
      * Returns whether this is a pipe resource in a legacy environment
      *

src/WritableResourceStream.php

@@ -8,15 +8,15 @@
 class WritableResourceStream extends EventEmitter implements WritableStreamInterface
 {
     private $stream;
-    public $softLimit = 65536;
+    private $loop;
+    private $softLimit;
 
     private $listening = false;
     private $writable = true;
     private $closed = false;
-    private $loop;
     private $data = '';
 
-    public function __construct($stream, LoopInterface $loop)
+    public function __construct($stream, LoopInterface $loop, $writeBufferSoftLimit = null)
     {
         if (!is_resource($stream) || get_resource_type($stream) !== "stream") {
             throw new \InvalidArgumentException('First parameter must be a valid stream resource');
@@ -35,6 +35,7 @@ public function __construct($stream, LoopInterface $loop)
 
         $this->stream = $stream;
         $this->loop = $loop;
+        $this->softLimit = ($writeBufferSoftLimit === null) ? 65536 : (int)$writeBufferSoftLimit;
     }
 
     public function isWritable()

tests/DuplexResourceStreamTest.php

@@ -4,6 +4,7 @@
 
 use React\Stream\DuplexResourceStream;
 use Clue\StreamFilter as Filter;
+use React\Stream\WritableResourceStream;
 
 class DuplexResourceStreamTest extends TestCase
 {
@@ -71,8 +72,6 @@ public function testConstructorAcceptsBuffer()
         $buffer = $this->getMockBuilder('React\Stream\WritableStreamInterface')->getMock();
 
         $conn = new DuplexResourceStream($stream, $loop, null, $buffer);
-
-        $this->assertSame($buffer, $conn->getBuffer());
     }
 
     public function testCloseShouldEmitCloseEvent()
@@ -284,12 +283,12 @@ public function testBufferEventsShouldBubbleUp()
         $stream = fopen('php://temp', 'r+');
         $loop = $this->createLoopMock();
 
-        $conn = new DuplexResourceStream($stream, $loop);
+        $buffer = new WritableResourceStream($stream, $loop);
+        $conn = new DuplexResourceStream($stream, $loop, null, $buffer);
 
         $conn->on('drain', $this->expectCallableOnce());
         $conn->on('error', $this->expectCallableOnce());
 
-        $buffer = $conn->getBuffer();
         $buffer->emit('drain');
         $buffer->emit('error', array(new \RuntimeException('Whoops')));
     }

tests/WritableStreamResourceTest.php

@@ -115,8 +115,7 @@ public function testWriteReturnsFalseWhenWritableResourceStreamIsFull()
         $loop = $this->createWriteableLoopMock();
         $loop->preventWrites = true;
 
-        $buffer = new WritableResourceStream($stream, $loop);
-        $buffer->softLimit = 4;
+        $buffer = new WritableResourceStream($stream, $loop, 4);
         $buffer->on('error', $this->expectCallableNever());
 
         $this->assertTrue($buffer->write("foo"));
@@ -132,8 +131,7 @@ public function testWriteReturnsFalseWhenWritableResourceStreamIsExactlyFull()
         $stream = fopen('php://temp', 'r+');
         $loop = $this->createLoopMock();
 
-        $buffer = new WritableResourceStream($stream, $loop);
-        $buffer->softLimit = 3;
+        $buffer = new WritableResourceStream($stream, $loop, 3);
 
         $this->assertFalse($buffer->write("foo"));
     }
@@ -148,8 +146,7 @@ public function testWriteDetectsWhenOtherSideIsClosed()
 
         $loop = $this->createWriteableLoopMock();
 
-        $buffer = new WritableResourceStream($a, $loop);
-        $buffer->softLimit = 4;
+        $buffer = new WritableResourceStream($a, $loop, 4);
         $buffer->on('error', $this->expectCallableOnce());
 
         fclose($b);
@@ -166,8 +163,7 @@ public function testEmitsDrainAfterWriteWhichExceedsBuffer()
         $stream = fopen('php://temp', 'r+');
         $loop = $this->createLoopMock();
 
-        $buffer = new WritableResourceStream($stream, $loop);
-        $buffer->softLimit = 2;
+        $buffer = new WritableResourceStream($stream, $loop, 2);
         $buffer->on('error', $this->expectCallableNever());
         $buffer->on('drain', $this->expectCallableOnce());
 
@@ -184,8 +180,7 @@ public function testWriteInDrain()
         $stream = fopen('php://temp', 'r+');
         $loop = $this->createLoopMock();
 
-        $buffer = new WritableResourceStream($stream, $loop);
-        $buffer->softLimit = 2;
+        $buffer = new WritableResourceStream($stream, $loop, 2);
         $buffer->on('error', $this->expectCallableNever());
 
         $buffer->once('drain', function () use ($buffer) {
@@ -209,8 +204,7 @@ public function testDrainAfterWrite()
         $stream = fopen('php://temp', 'r+');
         $loop = $this->createLoopMock();
 
-        $buffer = new WritableResourceStream($stream, $loop);
-        $buffer->softLimit = 2;
+        $buffer = new WritableResourceStream($stream, $loop, 2);
 
         $buffer->on('drain', $this->expectCallableOnce());
 
@@ -227,8 +221,7 @@ public function testDrainAfterWriteWillRemoveResourceFromLoopWithoutClosing()
         $loop = $this->createLoopMock();
         $loop->expects($this->once())->method('removeWriteStream')->with($stream);
 
-        $buffer = new WritableResourceStream($stream, $loop);
-        $buffer->softLimit = 2;
+        $buffer = new WritableResourceStream($stream, $loop, 2);
 
         $buffer->on('drain', $this->expectCallableOnce());
 
@@ -247,8 +240,7 @@ public function testClosingDuringDrainAfterWriteWillRemoveResourceFromLoopOnceAn
         $loop = $this->createLoopMock();
         $loop->expects($this->once())->method('removeWriteStream')->with($stream);
 
-        $buffer = new WritableResourceStream($stream, $loop);
-        $buffer->softLimit = 2;
+        $buffer = new WritableResourceStream($stream, $loop, 2);
 
         $buffer->on('drain', function () use ($buffer) {
             $buffer->close();