Download the PHP package cednore/boom-controller without Composer
On this page you can find all versions of the php package cednore/boom-controller. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cednore/boom-controller
More information about cednore/boom-controller
Files in cednore/boom-controller
Package boom-controller
Short Description Booming server control interface for Laravel
License MIT
Homepage http://github.com/cednore/boom-controller.git
Informations about the package boom-controller
boom-controller
Booming server control interface for Laravel
:exclamation: IMPORTANT: This project is not actively maintained. |
---|
boom-controller
is a composer package for Laravel
applications to control boom-server
microservice.
See boom-demo
for example usage of this project.
Currently, this project supports only
socket.io:^2.2.0
,laravel:^5.7|^6.0
andphp:^7|^8
.
Features
- Expose endpoints to listen
socket.io
events coming from frontend clients - PHP class to provide same interface as
socket.io
's Node.js server (for easy porting of legacy applications) - Facade for smooth syntax
- Authentication of traffic between
boom-server
and API - State machine over MySQL table to share list of sockets
Installation
Emit cheatsheet (comparison between legacy JavaScript syntax and new PHP syntax)
Basic emit
To all clients in the current namespace except the sender
To all clients in room1 except the sender
To all clients in room1 and/or room2 except the sender
To all clients in room1
To all clients in namespace "myNamespace"
To all clients in room1 in namespace "myNamespace"
To individual socketid (private message)
To all clients on this node (when using multiple nodes)
To all connected clients
Without compression
A message that might be dropped if the low-level transport is not writable
Configuration
The file config/boom.php
contains an array of configurations. See code comments inside this file for detailed
explanations.
Artisan commands
Command: boom:init
Initialize boom controller.
Usage:
Options:
Command: boom:make:nsp
Make a new socket.io namespace handler.
Usage:
Arguments:
Options:
Cloning
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See Installation chapter for notes on how to use this project on a live system.
Project roadmaps
- Testing desperately needed ;-)
- Resourceful documentation; Changelog, contribution guide, issue/PR templates, GitHub releases, dedicated documentation website
- Version compatibility check between
boom-controller
andboom-server
- CI/CD pipelines for building, testing and publishing
- Support higher
socket.io
andlaravel
versions - More smooth controller syntax
- Detailed error handling
- Memcached driver
- More stable db connection
- Dockerization of microservice
- Combine
boom-server
andboom-controller
in a single monorepo
License
This project is licensed under the MIT license. See full contents at LICENSE
file.