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

ZeroC Ice: Get channel tree without getting channel descriptions. #6355

Open
dexgs opened this issue Mar 5, 2024 · 1 comment
Open

ZeroC Ice: Get channel tree without getting channel descriptions. #6355

dexgs opened this issue Mar 5, 2024 · 1 comment
Labels
feature-request This issue or PR deals with a new feature ice server

Comments

@dexgs
Copy link
Contributor

dexgs commented Mar 5, 2024

Context

Writing software against the mumble server Ice API.

Description

Currently, the only ways to enumerate all the channels on a server are getTree() and getChannels(). Both these methods request the channel descriptions of every channel on the server. This results in a possibly very large request (especially if channel descriptions contain images), even if all you want to do is iterate over channel IDs.

For example: I am writing a simple channel viewer which only lists channel names and has no need for descriptions. Calling getTree() on my server results in a message that is ~3MiB in size, i.e. orders of magnitude larger than just the channel names and IDs. Additionally, the Ice client rejects a message this large unless I increase the max message size in my software.

What I am asking for is a way to request channel tree without downloading entire channel descriptions from the server. I think it would be best to add a new Ice API endpoint to the server in order to maintain backwards compatibility. This api endpoint would have the same behaviour as getTree(), except the description field of the returned Channel objects would be set to either null or the empty string.

Mumble component

Server

OS-specific?

No

Additional information

It would also be nice to have a similar function for fetching all online users without getting their user comments.

@dexgs dexgs added feature-request This issue or PR deals with a new feature triage This issue is waiting to be triaged by one of the project members labels Mar 5, 2024
@Krzmbrzl
Copy link
Member

Krzmbrzl commented Mar 5, 2024

Note that https://www.mumble.info/documentation/developer/channel-viewer-protocol/ is a thing
But generally, this is functionality that would also be useful in other contexts.

@Krzmbrzl Krzmbrzl added server ice and removed triage This issue is waiting to be triaged by one of the project members labels Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request This issue or PR deals with a new feature ice server
Projects
None yet
Development

No branches or pull requests

2 participants