caolan / caolan/mutiny

Awareness API

Open
#26 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
7
Forks
1
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.