Skip to content

Commit 00ab102

Browse files
committed
Prepare v1.4.1 release
1 parent c964db2 commit 00ab102

File tree

4 files changed

+23
-15
lines changed

4 files changed

+23
-15
lines changed

CHANGELOG.md

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

3+
## 1.4.1 (2019-10-28)
4+
5+
* Fix: Fix error reporting when invoking methods on closed socket instance.
6+
(#48 by @clue)
7+
8+
* Improve test suite to run tests on Windows via Travis CI.
9+
(#49 by @clue)
10+
311
## 1.4.0 (2019-01-22)
412

513
* Feature: Improve Windows support (async connections and Unix domain sockets).

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# clue/socket-raw [![Build Status](https://travis-ci.org/clue/php-socket-raw.svg?branch=master)](https://travis-ci.org/clue/php-socket-raw)
22

3-
Simple and lightweight OOP wrapper for PHP's low level sockets extension (ext-sockets)
3+
Simple and lightweight OOP wrapper for PHP's low-level sockets extension (ext-sockets)
44

5-
PHP offers two networking APIs, the newer [streams API](http://php.net/manual/en/book.stream.php) and the older [socket API](http://www.php.net/manual/en/ref.sockets.php).
5+
PHP offers two networking APIs, the newer [streams API](https://www.php.net/manual/en/book.stream.php) and the older [socket API](https://www.php.net/manual/en/ref.sockets.php).
66
While the former has been a huge step forward in generalizing various streaming resources,
7-
it lacks some of the advanced features of the original and much more low level socket API.
7+
it lacks some of the advanced features of the original and much more low-level socket API.
88
This lightweight library exposes this socket API in a modern way by providing a thin wrapper around the underlying API.
99

1010
* **Full socket API** -
11-
It exposes the whole [socket API](http://www.php.net/manual/en/ref.sockets.php) through a *sane* object-oriented interface.
11+
It exposes the whole [socket API](https://www.php.net/manual/en/ref.sockets.php) through a *sane* object-oriented interface.
1212
Provides convenience methods for common operations as well as exposing all underlying methods and options.
1313
* **Fluent interface** -
1414
Uses a fluent interface so you can easily chain method calls.
@@ -18,7 +18,7 @@ This lightweight library exposes this socket API in a modern way by providing a
1818
and does not get in your way.
1919
This library is merely a very thin wrapper and has no other external dependencies.
2020
* **Good test coverage** -
21-
Comes with an automated test suite and is regularly tested in the *real world*
21+
Comes with an automated test suite and is regularly tested in the *real world*.
2222

2323
**Table of contents**
2424

@@ -64,7 +64,7 @@ See also the [examples](examples).
6464
### Factory
6565

6666
As shown in the [quickstart example](#quickstart-example), this library uses a `Factory` pattern
67-
as a simple API to [`socket_create()`](http://www.php.net/manual/en/function.socket-create.php).
67+
as a simple API to [`socket_create()`](https://www.php.net/manual/en/function.socket-create.php).
6868
It provides simple access to creating TCP, UDP, UNIX, UDG and ICMP protocol sockets and supports both IPv4 and IPv6 addressing.
6969

7070
```php
@@ -75,8 +75,8 @@ $factory = new \Socket\Raw\Factory();
7575

7676
The `createClient(string $address, null|float $timeout): Socket` method is
7777
the most convenient method for creating connected client sockets
78-
(similar to how [`fsockopen()`](http://www.php.net/manual/en/function.fsockopen.php) or
79-
[`stream_socket_client()`](http://www.php.net/manual/en/function.stream-socket-client.php) work).
78+
(similar to how [`fsockopen()`](https://www.php.net/manual/en/function.fsockopen.php) or
79+
[`stream_socket_client()`](https://www.php.net/manual/en/function.stream-socket-client.php) work).
8080

8181
```php
8282
// establish a TCP/IP stream connection socket to www.google.com on port 80
@@ -107,7 +107,7 @@ $socket = $factory->createClient('icmp://192.168.0.1');
107107
#### createServer()
108108

109109
The `createServer($address)` method can be used to create a server side (listening) socket bound to specific address/path
110-
(similar to how [`stream_socket_server()`](http://www.php.net/manual/en/function.stream-socket-server.php) works).
110+
(similar to how [`stream_socket_server()`](https://www.php.net/manual/en/function.stream-socket-server.php) works).
111111
It accepts the same addressing scheme as the [`createClient()`](#createclient) method.
112112

113113
```php
@@ -152,7 +152,7 @@ The recommended way to create a `Socket` instance is via the above [`Factory`](#
152152

153153
All low-level socket operations are available as methods on the `Socket` class.
154154

155-
You can refer to PHP's fairly good [socket API documentation](http://www.php.net/manual/en/ref.sockets.php) or the docblock comments in the [`Socket` class](src/Socket.php) to get you started.
155+
You can refer to PHP's fairly good [socket API documentation](https://www.php.net/manual/en/ref.sockets.php) or the docblock comments in the [`Socket` class](src/Socket.php) to get you started.
156156

157157
##### Data I/O:
158158

@@ -195,7 +195,7 @@ This project follows [SemVer](https://semver.org/).
195195
This will install the latest supported version:
196196

197197
```bash
198-
$ composer require clue/socket-raw:^1.4
198+
$ composer require clue/socket-raw:^1.4.1
199199
```
200200

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

composer.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{
22
"name": "clue/socket-raw",
3-
"description": "Simple and lightweight OOP wrapper for PHP's low level sockets extension (ext-sockets)",
3+
"description": "Simple and lightweight OOP wrapper for PHP's low-level sockets extension (ext-sockets)",
44
"keywords": ["socket", "stream", "datagram", "dgram", "client", "server", "ipv6", "tcp", "udp", "icmp", "unix", "udg"],
55
"homepage": "https://github.com/clue/php-socket-raw",
66
"license": "MIT",
77
"authors": [
88
{
99
"name": "Christian Lück",
10-
"email": "christian@lueck.tv"
10+
"email": "christian@clue.engineering"
1111
}
1212
],
1313
"autoload": {

src/Socket.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
namespace Socket\Raw;
44

55
/**
6-
* simple and lightweight OOP wrapper for the low level sockets extension (ext-sockets)
6+
* Simple and lightweight OOP wrapper for the low-level sockets extension (ext-sockets)
77
*
88
* @author clue
9-
* @link https://github.com/clue/socket-raw
9+
* @link https://github.com/clue/php-socket-raw
1010
*/
1111
class Socket
1212
{

0 commit comments

Comments
 (0)