api-clients/pusher

Async first Pusher client

1.2.0 2019-08-15 09:58 UTC

Requires

• php: ^7.2
• api-clients/command-bus: ^2.0
• clue/block-react: ^1.1
• jean85/pretty-package-versions: ^1.0
• react/dns: ^1.0 || ^0.4.9
• react/http-client: ^0.5 || ^0.4.17
• reactivex/rxphp: ^2.0.4
• rx/helpers: ^1.0
• rx/operator-extras: ^2.1
• rx/websocket: ^2.0 || ^1.0
• voryx/event-loop: ^3.0 || ^2.0.2

Requires (Dev)

• api-clients/test-utilities: ^5.4

MIT

• Cees-Jan Kiewiet

README

Installation

To install via Composer, use the command below, it will automatically detect the latest version and bind it with ^.

composer require api-clients/pusher

Usage

$loop = Factory::create();
$client = AsyncClient::create($loop, 'Application ID here');
// OR when you need to specify the cluster
$client = AsyncClient::create($loop, 'Application ID here', null, 'cluster-here');

$client->channel('channel_name')->subscribe(
    function (Event $event) { // Gets called for each incoming event
        echo 'Channel: ', $event->getChannel(), PHP_EOL;
        echo 'Event: ', $event->getEvent(), PHP_EOL;
        echo 'Data: ', json_encode($event->getData()), PHP_EOL;
    },
    function ($e) { // Gets called on errors
        echo (string)$e;
    },
    function () { // Gets called when the end of the stream is reached
        echo 'Done!', PHP_EOL;
    }
);

$loop->run();

For more examples see the examples directory.

Features

This project aims to be 100% compatible with Pusher's features in v1.3.

• Subscribe to channels
• Presence channels
• Authentication

License

The MIT License (MIT)

Copyright (c) 2017 Cees-Jan Kiewiet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.