munshkr / browserglue Goto Github PK

• Make the binding port mandatory
• Update documentation diagrams

Warn only once when it disconnects (mention that it will keep retrying until told to stop).

This forces the client to have a single handler for each event type, useful for live coding environments that usually re-evaluate message handling routines.

Proposal: make .on replace the handler automatically, and define a .addEventListener for having multiple handlers for the same event.

This implies recreating the socket.

There should be a module that allows you to synchronize the server status (list of channels) between peers. It should be transport agnostic, so it could accept callbacks for updating local state from a remote channel (onUpdate), and for updating the state on remote peers (broadcast).

• Every channel has an owner.
• Any user can create channels and remove their own channels.
• If there is a new remote channel (i.e. another user created a channel), create the same chanel in the local browserglue instance, but without binding a port (this should be done by the local user).

bg.on(‘add-channel’, path => bg.addChannel(path));

• Only owners can remove their channels, but anyone can bind/unbind port to them, or subscribe/unsubscribe to some port in their local browserglue instance. That is, each user is responsible for assigning local ports (bind or subscribe) in their machine.
• If a user removes some channel, that channel is automatically removed from everybody else.

bg.on(‘remove-channel’, path => bg.removeChannel(path));

https://github.com/adzialocha/osc-js/wiki/Low-Level-API

The client interface should expose some simpler methods for the most common use cases.

This implies recreating the socket.

Right now a channel is created by specifying a path, which is then used in the WebSockets server. But it's kinda confusing that there are two paths: the channel path and the OSC message path.

Maybe we can allow any name instead, and slugify the name and use that as path. For example:

client.addChannel("This is my Channel")
// it will use /data/this-is-my-channel

Right now it only receives messages from an OSC address named as the channel. The name of the channel should be an arbitrary name.

Maybe I should use some logger with verbosity levels, so it's quiet by default.