Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Awareness API #26

Open
caolan opened this issue Jun 24, 2024 · 0 comments
Open

Awareness API #26

caolan opened this issue Jun 24, 2024 · 0 comments

Comments

@caolan
Copy link
Owner

caolan commented Jun 24, 2024

In addition to message channels (that try to ensure delivery) - there should be an API for more ephemeral data like away status or cursor positions. These only need to work for online peers and delivery does not need to be guaranteed.

(split from #22)

awareness(peer_id, app_instance_uuid, message)

Sends an ephemeral message to another online peer. No retries are attempted and it is not queued: the message either succeeds or fails on first attempt. Delivery order might not be guaranteed. Any received messages awaiting processing are dropped when mutiny-app is closed.

This can be used for ephemeral data like away/typing notifications, cursor positions, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant