Event Bus Service (Beta)

Event Bus service is a powerful communication system that helps your blocklet's components work together seamlessly. Imagine it as a smart messaging center that:

• Lets different blocklets (which are like mini-apps within your system) share information and notify each other about important changes
• Creates a smooth connection between your blocklets and the main server that manages everything

For example, if you have a shopping blocklet and an inventory blocklet, the Event Bus would help them stay synchronized - when someone buys an item, the inventory blocklet would automatically know to update its stock count.

Usage#

Define Events#

To get started, you'll need to specify what kinds of messages (events) your blocklet can send. This is done by listing them in your blocklet.yml configuration file, which acts like a rulebook for your blocklet's behavior.

Here are some important guidelines when naming your events:

• Think of event names like describing an action: start with what's happening (like "post" or "user") followed by what was done (like "published" or "updated"). For example: "post.published" or "user.loggedIn"
• Each event name needs to be unique in your blocklet - you can't have two events with the same name
• Don't use names that start with "blocklet." - these names are reserved for system use
• Make sure to write clear descriptions for your events - these will help other developers understand what your events do

Publish Events#

Before your blocklet can send out any messages (events), you need to list them in your blocklet's configuration file (blocklet.yml) - think of this like registering what kinds of announcements your blocklet is allowed to make. This helps keep communication organized and prevents confusion about which blocklet is sending what messages.

Receive Events#

Your blocklet can listen for messages (events) from other blocklets and the server. However, it won't receive the specific events that it has declared in its own blocklet.yml file - this prevents a blocklet from receiving its own messages, which helps avoid confusion and feedback loops.

Discover Events#

Want to know what events are available in your blocklet? You can find a complete list at the /.well-known/service/openevent.json web address. This list shows all the events that your blocklet and other blocklets can send and receive - it's like a directory of all possible messages that can be shared between different parts of your application.