Socket IO Broadcast Driver for Masonite
Project description
What is SocketIo-Driver?
It's an extra broadcast driver support for SocketIO in masonite 4, it extends default masonite broadcast driver to support SocketIO.
Masonite Broadcast Server and Client Library
Setup
Install package using pip:
pip install masonite-socketio-driver
Add provider inside config/providers.py.
from socketio_driver.providers import SocketProvider
PROVIDERS = [
...,
# Application Providers
SocketProvider,
]
Driver Config
Add following configuration inside config/broadcast.py after "pusher": {...},
"pusher": {...},
"socketio": {
"driver": "socketio",
"host": env("BROADCAST_HOST", "localhost"),
"port": env("BROADCAST_PORT", "6379")
},
Add following keys in .env
.
BROADCAST_HOST=
BROADCAST_PORT=
Update the broadcast driver value to socketio
in .env
BROADCAST_DRIVER=socketio
Example
from masonite.controllers import Controller
from masonite.broadcasting import Broadcast
class YourController(Controller):
def your_function(self, broadcast: Broadcast):
broadcast_data = {
"message": "Hello World"
}
broadcast.channel(["channel-name"], "event-name", broadcast_data)
Helpers
List all connected clients:
from socketio_driver.facades import Communicator
communicator.clients() # get list of connected clients
communicator.client(id='client-id') # get client by id, id is basically a socket.io session id
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for masonite-socketio-driver-2.0.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c1d9914fab78a9413042e5477b763223e4a5c1cdbbfc81f1731c5b61348cd4e2 |
|
MD5 | 021468bca6ef1efb989bd1a07e0a4063 |
|
BLAKE2b-256 | 8e331ece29767d1c829f6292109479f903a03335a71b546718072941258d19f7 |
Close
Hashes for masonite_socketio_driver-2.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c1653bcbb5a0c250df34ea7ef6384c3951b461a222318147015cee459c1fe8a0 |
|
MD5 | 20934544c45ac60d9785ce8fc6785131 |
|
BLAKE2b-256 | 5ab494d5bc11e33ac590c9bab7ffb931dfc992b1b11b32bd68c99172bf67b589 |