livekit / protocol

LiveKit protocol. Protobuf definitions for LiveKit's signaling protocol
https://docs.livekit.io
Apache License 2.0
68 stars 61 forks source link

Adding a simulation option for leave request. #713

Closed boks1971 closed 2 months ago

boks1971 commented 2 months ago

@lukasIO I was thinking of making the simulation option just a LeaveRequest. And when simulating, client side can just set Action field of LeaveRequest. But, decided against it as I did not see the use case for it and also wanted to keep it simple/specific.

Let me know if I should change that to a generic LeaveRequest. If doing generic LeaveRequest, server behaviour would be

  1. Action = DISCONNECT: server will close the participant and send a LeaveRequest with Action = DISCONNECT.
  2. Action = RESUME, server will send LeaveRequest with Action = RESUME and it will not include self region in RegionSettings.
  3. Action = RECONNECT, server will send LeaveRequest with Action = RECONNECT and it will not include self region in RegionSettings.

As the current simulation is only for full reconnect, it will behave like #3 above.

Also, this option will be supported only in cloud.

Please let me know if I should change this or just leave it as a boolean.

changeset-bot[bot] commented 2 months ago

⚠️ No Changeset found

Latest commit: 0dbbb848c8a7f18e3b538528d15970de19ecee1f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

💥 An error occurred when fetching the changed packages and changesets in this PR ``` Some errors occurred when validating the changesets config: The package or glob expression "github.com/livekit/protocol" specified in the `fixed` option does not match any package in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch. ```