Download the PHP package friendsofhyperf/ipc-broadcaster without Composer
On this page you can find all versions of the php package friendsofhyperf/ipc-broadcaster. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download friendsofhyperf/ipc-broadcaster
More information about friendsofhyperf/ipc-broadcaster
Files in friendsofhyperf/ipc-broadcaster
Package ipc-broadcaster
Short Description IPC broadcaster component for Hyperf.
License MIT
Informations about the package ipc-broadcaster
Ipc Broadcaster
中文说明
Broadcast serializable messages between Hyperf server workers and user processes.
Installation
The package automatically registers its ConfigProvider. It binds
BroadcasterInterface to AllProcessesBroadcaster and registers the listeners required
to receive messages in server workers. There is no configuration file to publish.
The package declares hyperf/event ~3.2.0 and no optional dependencies in its
composer.json. Use it in a Hyperf server application that provides the server, process,
container, and DI runtime classes used by the broadcasters.
Broadcast Messages
The broadcast() function accepts an IpcMessageInterface instance or a closure. By
default, it uses AllProcessesBroadcaster to send the message to all other server workers
and all registered coroutine user processes.
Class Message
Extend IpcMessage and implement handle(). IpcMessage also provides
getFromWorkerId() and setFromWorkerId() through InteractsWithFromWorkerId. When a
server worker receives the message, getFromWorkerId() contains the sending worker ID.
Message objects and their properties must be serializable so they can cross process boundaries.
Closure Message
Closures are wrapped in ClosureIpcMessage and serialized before broadcasting. Values
captured by the closure must therefore also be serializable. In a normal Hyperf DI
environment, typed closure parameters can be resolved from the container.
Select Targets
Inject BroadcasterInterface for the default all-processes behavior, or construct a
specific broadcaster to select targets:
ServerBroadcaster accepts a container and an optional worker ID. Without an ID, it sends
to every server worker except the current worker. UserProcessesBroadcaster accepts an
optional process name and process ID. Without either, it sends to all registered user
processes collected by Hyperf's ProcessCollector.
Handle Messages in User Processes
The component automatically calls handle() for messages received by server workers. In
a user process, Hyperf dispatches a Hyperf\Process\Event\PipeMessage; the component does
not automatically call the contained message's handle() method. Register a listener when
the user process should execute the message:
Run in the Current Worker
By default, broadcasts do not execute in the current server worker. Add
RunsInCurrentWorker to a message to call handle() once in the current worker before it
is sent to the selected targets:
Coroutine Server Limitation
After MainCoroutineServerStart, cross-process broadcasting is disabled and broadcaster
calls return without sending messages. A message using RunsInCurrentWorker still runs
once locally before the broadcaster returns.