Skip to content

Awareness API #26

Description

@caolan

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions