README

English	Português

Synopsis

This repository contains the necessary functionalities to run a Publish/Subscribe system, making it possible to subscribe and publish events.

composer require iquety/pubsub

For detailed information, see Documentation Summary.

How it works

1. Run the event server

At the root of this repository, there is a terminal command to exemplify the process. It can be used as follows:

# running in local PHP
./example pubsub:broker -c 'tests/Example/config-file.php' -v

ou

# running in Dockerized PHP
./composer pubsub-server

# Server terminal running

➜ Using JsonEventSerializer serializer
➜ Verbose mode enabled
✔ The publish/subscriber server has been started in tcp://localhost:7703

Ready! The event server is running on port 7703, which will be available to receive events.

Note: while the server is running, the current terminal will be in "watch" mode, waiting to receive events. The "-v" option activates the "verbose" mode, so that whenever an event is received, the server will notify the running terminal.

3. Send events to the server

With the server running, just open another terminal and use the command below to send some test events:

# running in local PHP
./example pubsub:client-test -d localhost -p 7703 -v

ou

# running in Dockerized PHP
./composer pubsub-client

The two terminals will react to the sending of events, showing the corresponding information:

# Terminal where events were sent

✔ Publish event of type 'EventOne' to channel 'channel-vormir' in tcp://localhost:7703
✔ Publish event of type 'EventTwo' to channel 'channel-vormir' in tcp://localhost:7703
✔ Publish event of type 'EventTwo' to channel 'channel-mordor' in tcp://localhost:7703
✔ Publish event of type 'EventTwo' to channel 'channel-greenville' in tcp://localhost:7703
➜ Published Events
➜ Used memory: 1921928

# Server terminal that received the events

➜ [2022-06-03 17:06:09]: Message of type 'EventOne' received on channel 'channel-vormir'
Message dispatched to SubscriberOne
Message dispatched to SubscriberTwo

➜ [2022-06-03 17:06:09]: Message of type 'EventTwo' received on channel 'channel-vormir'
Message dispatched to SubscriberTwo

...

Características

Made for PHP 8.0 or higher;
Coded with best practices and maximum quality;
Well documented and IDE friendly;
Made with TDD (Test Driven Development);
Implemented with unit tests using PHPUnit;
Made with ❤️ & ☕.

Credits

Ricardo Pereira Dias

iquety / pubsub

Maintainers

Details