Skip to content

Commit eeff725

Browse files
committed
Prepare v1.3.0 release
1 parent 72a87db commit eeff725

File tree

3 files changed

+56
-5
lines changed

3 files changed

+56
-5
lines changed

CHANGELOG.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# Changelog
22

3+
## 1.3.0 (2018-02-13)
4+
5+
* Feature: Support communication over Unix domain sockets (UDS)
6+
(#20 by @clue)
7+
8+
```php
9+
// new: now supports communication over Unix domain sockets (UDS)
10+
$proxy = new ProxyConnector('http+unix:///tmp/proxy.sock', $connector);
11+
```
12+
13+
* Reduce memory consumption by avoiding circular reference from stream reader
14+
(#18 by @valga)
15+
16+
* Improve documentation
17+
(#19 by @clue)
18+
319
## 1.2.0 (2017-08-30)
420

521
* Feature: Use socket error codes for connection rejections
@@ -26,7 +42,7 @@
2642

2743
```php
2844
// new: username/password will now be passed to HTTP proxy server
29-
$proxy = new ProxyConnector('user:pass@127.0.0.1:8080');
45+
$proxy = new ProxyConnector('user:pass@127.0.0.1:8080', $connector);
3046
```
3147

3248
## 1.0.0 (2017-06-10)

README.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,36 @@
11
# clue/http-proxy-react [![Build Status](https://travis-ci.org/clue/php-http-proxy-react.svg?branch=master)](https://travis-ci.org/clue/php-http-proxy-react)
22

3-
Async HTTP proxy connector, use any TCP/IP protocol through an HTTP CONNECT proxy server,
4-
built on top of [ReactPHP](https://reactphp.org).
3+
Async HTTP proxy connector, use any TCP/IP-based protocol through an HTTP
4+
CONNECT proxy server, built on top of [ReactPHP](https://reactphp.org).
5+
6+
HTTP CONNECT proxy servers (also commonly known as "HTTPS proxy" or "SSL proxy")
7+
are commonly used to tunnel HTTPS traffic through an intermediary ("proxy"), to
8+
conceal the origin address (anonymity) or to circumvent address blocking
9+
(geoblocking). While many (public) HTTP CONNECT proxy servers often limit this
10+
to HTTPS port `443` only, this can technically be used to tunnel any
11+
TCP/IP-based protocol (HTTP, SMTP, IMAP etc.).
12+
This library provides a simple API to create these tunneled connection for you.
13+
Because it implements ReactPHP's standard
14+
[`ConnectorInterface`](https://github.com/reactphp/socket#connectorinterface),
15+
it can simply be used in place of a normal connector.
16+
This makes it fairly simple to add HTTP CONNECT proxy support to pretty much any
17+
existing higher-level protocol implementation.
18+
19+
* **Async execution of connections** -
20+
Send any number of HTTP CONNECT requests in parallel and process their
21+
responses as soon as results come in.
22+
The Promise-based design provides a *sane* interface to working with out of
23+
bound responses and possible connection errors.
24+
* **Standard interfaces** -
25+
Allows easy integration with existing higher-level components by implementing
26+
ReactPHP's standard
27+
[`ConnectorInterface`](https://github.com/reactphp/socket#connectorinterface).
28+
* **Lightweight, SOLID design** -
29+
Provides a thin abstraction that is [*just good enough*](http://en.wikipedia.org/wiki/Principle_of_good_enough)
30+
and does not get in your way.
31+
Builds on top of well-tested components and well-established concepts instead of reinventing the wheel.
32+
* **Good test coverage** -
33+
Comes with an automated tests suite and is regularly tested against actual proxy servers in the wild
534

635
**Table of contents**
736

@@ -329,14 +358,20 @@ $proxy = new ProxyConnector('http+unix://user:pass@/tmp/proxy.sock', $connector)
329358
The recommended way to install this library is [through Composer](https://getcomposer.org).
330359
[New to Composer?](https://getcomposer.org/doc/00-intro.md)
331360

361+
This project follows [SemVer](http://semver.org/).
332362
This will install the latest supported version:
333363

334364
```bash
335-
$ composer require clue/http-proxy-react:^1.2
365+
$ composer require clue/http-proxy-react:^1.3
336366
```
337367

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

370+
This project aims to run on any platform and thus does not require any PHP
371+
extensions and supports running on legacy PHP 5.3 through current PHP 7+ and
372+
HHVM.
373+
It's *highly recommended to use PHP 7+* for this project.
374+
340375
## Tests
341376

342377
To run the test suite, you first need to clone this repo and then install all

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "clue/http-proxy-react",
3-
"description": "Async HTTP proxy connector, use any TCP/IP protocol through an HTTP CONNECT proxy server, built on top of ReactPHP",
3+
"description": "Async HTTP proxy connector, use any TCP/IP-based protocol through an HTTP CONNECT proxy server, built on top of ReactPHP",
44
"keywords": ["HTTP", "CONNECT", "proxy", "ReactPHP", "async"],
55
"homepage": "https://github.com/clue/php-http-proxy-react",
66
"license": "MIT",

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy