Skip to content

Commit c05a50b

Browse files
committed
Prepare v2.0.0 release
1 parent ed2a556 commit c05a50b

3 files changed

Lines changed: 37 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,41 @@
11
# Changelog
22

3+
## 2.0.0 (2017-09-16)
4+
5+
A major compatibility release to update this component to support all latest
6+
ReactPHP components!
7+
8+
This update involves a minor BC break due to dropped support for legacy
9+
versions. We've tried hard to avoid BC breaks where possible and minimize impact
10+
otherwise. We expect that most consumers of this package will actually not be
11+
affected by any BC breaks, see below for more details.
12+
13+
* BC break: Remove deprecated API and mark Sender as @internal only,
14+
remove all references to legacy SocketClient component and
15+
remove support for Unix domain sockets (UDS) for now
16+
(#77, #78, #81 and #83 by @clue)
17+
18+
> All of this affects the `Sender` only, which was previously marked as
19+
"advanced usage" and is now marked `@internal` only. If you've not
20+
used this class before, then this BC break will not affect you.
21+
If you've previously used this class, then it's recommended to first
22+
update to the intermediary v1.4.0 release, which allows you to use a
23+
standard `ConnectorInterface` instead of the `Sender` and then update
24+
to this version without causing a BC break.
25+
If you've previously used Unix domain sockets (UDS), then you're
26+
recommended to wait for the next version.
27+
28+
* Feature / BC break: Forward compatibility with future Stream v1.0 and strict stream semantics
29+
(#79 by @clue)
30+
31+
> This component now follows strict stream semantics. This is marked as a
32+
BC break because this removes undocumented and untested excessive event
33+
arguments. If you've relied on proper stream semantics as documented
34+
before, then this BC break will not affect you.
35+
36+
* Feature: Forward compatibility with future Socket and EventLoop components
37+
(#80 by @clue)
38+
339
## 1.4.0 (2017-09-15)
440

541
* Feature: `Browser` accepts `ConnectorInterface` and deprecate legacy `Sender`

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -446,8 +446,6 @@ See also the [SOCKS example](examples/11-socks-proxy.php).
446446

447447
### Options
448448

449-
Note: This API is subject to change.
450-
451449
The [`Browser`](#browser) class exposes several options for the handling of
452450
HTTP transactions. These options resemble some of PHP's
453451
[HTTP context options](http://php.net/manual/en/context.http.php) and
@@ -473,7 +471,7 @@ The recommended way to install this library is [through Composer](https://getcom
473471
This will install the latest supported version:
474472

475473
```bash
476-
$ composer require clue/buzz-react:^1.4
474+
$ composer require clue/buzz-react:^2.0
477475
```
478476

479477
See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.

src/Io/Sender.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ class Sender
4545
* ```php
4646
* $connector = new \React\Socket\Connector($loop);
4747
* $sender = \Clue\React\Buzz\Io\Sender::createFromLoop($loop, $connector);
48-
* $browser = new \Clue\React\Buzz\Browser($loop, $sender);
4948
* ```
5049
*
5150
* @param LoopInterface $loop

0 commit comments

Comments
 (0)