Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edefimov/async-sockets
Library for asynchronous work with sockets based on php streams
https://github.com/edefimov/async-sockets
async asynchronous library php sockets
Last synced: 12 days ago
JSON representation
Library for asynchronous work with sockets based on php streams
- Host: GitHub
- URL: https://github.com/edefimov/async-sockets
- Owner: edefimov
- License: mit
- Created: 2015-04-20T04:46:32.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-12-08T10:30:26.000Z (almost 3 years ago)
- Last Synced: 2024-04-23T19:38:44.040Z (7 months ago)
- Topics: async, asynchronous, library, php, sockets
- Language: PHP
- Homepage:
- Size: 899 KB
- Stars: 43
- Watchers: 6
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Async sockets library
=====================
[](https://travis-ci.org/edefimov/async-sockets)
[](http://async-sockets.readthedocs.io/en/latest/?badge=latest)
[](https://scrutinizer-ci.com/g/edefimov/async-sockets/)
[](https://insight.sensiolabs.com/projects/c816a980-e97a-46ae-b334-16c6bfd1ec4a)
[](https://scrutinizer-ci.com/g/edefimov/async-sockets/)
[](https://github.com/edefimov/async-sockets/releases/latest)
[](https://www.versioneye.com/user/projects/55525b5706c318305500014b)
[](https://packagist.org/packages/edefimov/async-sockets)
[](https://php.net/)
Async sockets is event-based library for asynchronous work with sockets built on php streams.
## Features
- multiple requests execution at once
- distinguish frame boundaries
- server socket support
- persistent connections support
- multiple persistent connections to the same host:port
- processing TLS handshake asynchronous
- synchronization between sockets
- determine datagram size for UDP sockets
- all transports returned by stream_get_transports are supported
- compatible with symfony event dispatcher component
- full control over timeouts
- dynamically adding new request during execution process
- separate timeout values for each socket
- custom sockets setup by php stream contexts
- custom user context for each socket
- stop request either for certain socket or for all of them
- strategies for limiting number of running requests
- error handling is based on exceptions
- supports libevent engine
## What is it for
Async sockets library provides networking layer for applications, hides complexity of I/O operations,
and cares about connections management. The library will be a powerful base for implementing
arbitrary networking protocol as for implementing server on PHP.
Running multiple requests at once decreases delay of I/O operation
to the size of timeout assigned to the slowest server.
## Documentation
[Stable version](https://async-sockets.readthedocs.io/en/stable/)
[Latest version](https://async-sockets.readthedocs.io/en/latest/)
## Installation
The recommended way to install async sockets library is through composer
stable version:
```
$ composer require edefimov/async-sockets:~0.3.0 --prefer-dist|--prefer-source
```
actual version:
```
$ composer require edefimov/async-sockets:dev-master
```
Use `--prefer-dist` option in production environment, so as it ignores downloading of test and demo files,
and `--prefer-source` option for development. Development version includes both test and demo files.
## Quick start
#### Step 1. Create `AsyncSocketFactory` at point where you want to start request
```php
$factory = new AsyncSocketFactory();
```
#### Step 2. Create RequestExecutor and proper amount of sockets
```php
$client = $factory->createSocket(AsyncSocketFactory::SOCKET_CLIENT);
$anotherClient = $factory->createSocket(AsyncSocketFactory::SOCKET_CLIENT);
$executor = $factory->createRequestExecutor();
```
#### Step 3. Create event handler with events, you are interested in
```php
$handler = new CallbackEventHandler(
[
EventType::INITIALIZE => [$this, 'onInitialize'],
EventType::CONNECTED => [$this, 'onConnected'],
EventType::WRITE => [$this, 'onWrite'],
EventType::READ => [$this, 'onRead'],
EventType::ACCEPT => [$this, 'onAccept'],
EventType::DATA_ALERT => [$this, 'onDataAlert'],
EventType::DISCONNECTED => [$this, 'onDisconnected'],
EventType::FINALIZE => [$this, 'onFinalize'],
EventType::EXCEPTION => [$this, 'onException'],
EventType::TIMEOUT => [$this, 'onTimeout'],
]
);
```
#### Step 4. Add sockets into RequestExecutor
```php
$executor->socketBag()->addSocket(
$client,
new WriteOperation(),
[
RequestExecutorInterface::META_ADDRESS => 'tls://github.com:443',
RequestExecutorInterface::META_CONNECTION_TIMEOUT => 30,
RequestExecutorInterface::META_IO_TIMEOUT => 5,
],
$handler
);
$executor->socketBag()->addSocket(
$anotherClient,
new WriteOperation(),
[
RequestExecutorInterface::META_ADDRESS => 'tls://packagist.org:443',
RequestExecutorInterface::META_CONNECTION_TIMEOUT => 10,
RequestExecutorInterface::META_IO_TIMEOUT => 2,
],
$handler
);
```
#### Step 5. Execute it!
```php
$executor->executeRequest();
```
## Example usage
### Client socket
```php
$factory = new AsyncSocketFactory();
$client = $factory->createSocket(AsyncSocketFactory::SOCKET_CLIENT);
$anotherClient = $factory->createSocket(AsyncSocketFactory::SOCKET_CLIENT);
$executor = $factory->createRequestExecutor();
$handler = new CallbackEventHandler(
[
EventType::INITIALIZE => [$this, 'onInitialize'],
EventType::CONNECTED => [$this, 'onConnected'],
EventType::WRITE => [$this, 'onWrite'],
EventType::READ => [$this, 'onRead'],
EventType::DISCONNECTED => [$this, 'onDisconnected'],
EventType::FINALIZE => [$this, 'onFinalize'],
EventType::EXCEPTION => [$this, 'onException'],
EventType::TIMEOUT => [$this, 'onTimeout'],
]
);
$executor->socketBag()->addSocket(
$client,
new WriteOperation(),
[
RequestExecutorInterface::META_ADDRESS => 'tls://github.com:443',
RequestExecutorInterface::META_CONNECTION_TIMEOUT => 30,
RequestExecutorInterface::META_IO_TIMEOUT => 5,
],
$handler
);
$executor->socketBag()->addSocket(
$anotherClient,
new WriteOperation(),
[
RequestExecutorInterface::META_ADDRESS => 'tls://packagist.org:443',
RequestExecutorInterface::META_CONNECTION_TIMEOUT => 10,
RequestExecutorInterface::META_IO_TIMEOUT => 2,
],
$handler
);
$executor->executeRequest();
```
See full example [here](https://github.com/edefimov/async-sockets/blob/0.3.0/demos/Demo/RequestExecutorClient.php)
### Server socket
```php
$factory = new AsyncSocketFactory();
$serverSocket = $factory->createSocket(AsyncSocketFactory::SOCKET_SERVER);
$executor = $factory->createRequestExecutor();
$executor->socketBag()->addSocket(
$serverSocket,
new ReadOperation(),
[
RequestExecutorInterface::META_ADDRESS => "tcp://localhost:10280", // or "udp://localhost:10280"
RequestExecutorInterface::META_CONNECTION_TIMEOUT => RequestExecutorInterface::WAIT_FOREVER,
RequestExecutorInterface::META_IO_TIMEOUT => RequestExecutorInterface::WAIT_FOREVER,
],
new CallbackEventHandler(
[
EventType::ACCEPT => function (AcceptEvent $event){
$event->getExecutor()->socketBag()->addSocket(
$event->getClientSocket(),
new ReadOperation(),
[ ],
// client handlers
);
}
]
)
);
$executor->executeRequest();
```
See full example [here](https://github.com/edefimov/async-sockets/blob/0.3.0/demos/Demo/SimpleServer.php)