Add JSON-RPC access to directories and server lists (without connect/disconnect methods) #3479

ann0see · 2025-02-13T10:25:02Z

Short description of changes

Modified version of: #3249

Removed disconnect and connect methods since calling them would break the UI
Rebased to main

Quoting the initial PR:

Adds JSON-RPC notification of server lists from directories. Allows polling a directory for this info.

CHANGELOG: Added jamulusclient/pollServerList methods and jamulusclient/receivedServerList notification to JSON-RPC interface.

Context: Fixes an issue?

As discussed here, it may be advantageous to increase the control and monitoring provided by the JSON-RPC interface. This provides access to server lists on directories.

Does this change need documentation? What needs to be documented and how?

This PR adds the associated documentation of the new method and notification in the JSON-RPC md page.

Status of this Pull Request

To be tested.

What is missing until this pull request can be merged?

Checklist

I've verified that this Pull Request follows the general code principles
I tested my code and it does what I want
My code follows the style guide
I waited some time after this Pull Request was opened and all GitHub checks completed without errors.
I've filled all the content above

Squash from: jamulussoftware#3249 rpc_notification jamulusclient/serverListReceived rpc_method jamulus/pollServerList Change JSON-RPC for server list. Use pollServerList instead of getServerList. (No result returned from the call.) Change "address" to "url" Adds documentation for new JSON-RPC methods Consistent use of countryId Fixes JSON-RPC docs JSON-RPC fixes for feedback to PR Changes method "jamulus/pollServerList" to "jamulusclient/pollServerList" (for consistency). Changes "url" to "address" in protocol and "server address" in docs. Fixes typo in countryId. JSON-RPC Enhancements Adds jamulusclient/connect method. Adds jamulusclient/disconnect method. Adds jamulusclient/serverInfoReceived notification. Return country string rather than (QT specific) country code. Request server info after server list received (to get each server's ping time and num clients). JSON-RPC enhancements Adds method jamulusclient/recorderState. Changes intrument code to instrument name (remote client may not have access to lookup table). Fixes errors in docs. Fixes coding style Update docs Fix coding style

These methods unfortunately break the GUI if called

ann0see · 2025-02-13T10:32:07Z

I'd like to process with the content of #3249 without the disconnect and connect methods.
Second review will follow.

@riban-bw since you wrote the initial code, I'd also like to hear your opinion once reviews happen here.

docs/JSON-RPC.md

softins

Added a number of suggestions.

docs/JSON-RPC.md

src/clientrpc.cpp

docs/JSON-RPC.md

src/clientrpc.cpp

Co-authored-by: Tony Mountifield <[email protected]>

mcfnord · 2025-02-22T18:31:21Z

docs/JSON-RPC.md

@@ -129,6 +129,23 @@ Results:
 | result.version | string | The Jamulus version. |


+### jamulus/pollServerList
+
+Request list of servers in a directory


Suggested change

Request list of servers in a directory

Request list of servers in a directory.

mcfnord · 2025-02-22T18:32:36Z

docs/JSON-RPC.md

@@ -129,6 +129,23 @@ Results:
 | result.version | string | The Jamulus version. |


Consistency on a page is a mercy for readers, and this page consistently puts a period behind non-sentences. Ideally, none would include a period.

mcfnord · 2025-02-22T18:35:55Z

docs/JSON-RPC.md

+
+| Name | Type | Description |
+| --- | --- | --- |
+| params.directory | string | socket address of directory to query, e.g. anygenre1.jamulus.io:22124. |


mcfnord · 2025-02-22T18:37:52Z

docs/JSON-RPC.md

+
+| Name | Type | Description |
+| --- | --- | --- |
+| params.state | number | The recorder state |


mcfnord · 2025-02-22T18:38:05Z

docs/JSON-RPC.md

+
+| Name | Type | Description |
+| --- | --- | --- |
+| params.address | string | The server socket address |


mcfnord · 2025-02-22T18:38:15Z

docs/JSON-RPC.md

+| Name | Type | Description |
+| --- | --- | --- |
+| params.address | string | The server socket address |
+| params.pingtime | number | The round-trip ping time in ms |


mcfnord · 2025-02-22T18:40:15Z

docs/JSON-RPC.md

+| --- | --- | --- |
+| params.address | string | The server socket address |
+| params.pingtime | number | The round-trip ping time in ms |
+| params.numClients | number | The quantity of clients connected to the server |


Suggested change

| params.numClients | number | The quantity of clients connected to the server |

| params.numClients | number | The number of clients connected to the server. |

Perhaps there's a notion that the definition of something shouldn't use the same word. Maybe. But the only existing similar usage on this page is result.clients[*].channels, and it says number rather than quantity.

(And the aim is to contextualise "number of clients" rather than explain "number", "of" or "clients".)

Sorry! I tend to use the word, "quantity" in docs to avoid ambiguity. Feel free to use the language with which you feel most comfortable.

mcfnord · 2025-02-22T18:40:32Z

docs/JSON-RPC.md

+| Name | Type | Description |
+| --- | --- | --- |
+| params.servers | array | The server list. |
+| params.servers[*].address | string | Socket address (ip_address:port) |


mcfnord · 2025-02-22T18:40:43Z

docs/JSON-RPC.md

+| --- | --- | --- |
+| params.servers | array | The server list. |
+| params.servers[*].address | string | Socket address (ip_address:port) |
+| params.servers[*].name | string | Server name |


mcfnord · 2025-02-22T18:40:58Z

docs/JSON-RPC.md

+| params.servers[*].address | string | Socket address (ip_address:port) |
+| params.servers[*].name | string | Server name |
+| params.servers[*].countryId | number | Server country ID (see QLocale::Country). |
+| params.servers[*].country | string | Server country |


Co-authored-by: mcfnord <[email protected]>

ann0see

@mcfnord applied. Thanks. I agree the "." change looks strange.

pljones · 2025-03-01T10:28:19Z

src/client.h

@@ -286,6 +286,8 @@ class CClient : public QObject
        Channel.GetBufErrorRates ( vecErrRates, dLimit, dMaxUpLimit );
    }

+    CProtocol* getConnLessProtocol() { return &ConnLessProtocol; }


Hm. pClient gets passed to ClientRpc, which isn't a problem for threading. That should make calls to pClient->anything() thread-safe, right?

I'd just be more comfortable not to dig around inside pClient to the internals -- if pClient should expose a change, it should have its own slot exposing that and signal it itself.

ann0see force-pushed the jsonrpc/addDirectoryMethods branch from d830548 to 324c588 Compare February 13, 2025 10:26

ann0see added this to the Release 3.12.0 milestone Feb 13, 2025

Remove connect/disconnect methods

3c89fe5

These methods unfortunately break the GUI if called

ann0see force-pushed the jsonrpc/addDirectoryMethods branch from 324c588 to 3c89fe5 Compare February 13, 2025 10:28

ann0see requested review from pljones and softins February 13, 2025 10:30

ann0see commented Feb 13, 2025

View reviewed changes

docs/JSON-RPC.md Show resolved Hide resolved

docs/JSON-RPC.md Show resolved Hide resolved

softins reviewed Feb 13, 2025

View reviewed changes

riban-bw mentioned this pull request Feb 14, 2025

Add JSON-RPC access to directories and server lists. #3249

Closed

5 tasks

Re-add ids

b7d7a14

Co-authored-by: Tony Mountifield <[email protected]>

mcfnord reviewed Feb 22, 2025

View reviewed changes

Apply stylistic changes

dcac4cc

Co-authored-by: mcfnord <[email protected]>

ann0see commented Feb 28, 2025

View reviewed changes

ann0see requested a review from mcfnord February 28, 2025 20:16

pljones reviewed Mar 1, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add JSON-RPC access to directories and server lists (without connect/disconnect methods) #3479

Add JSON-RPC access to directories and server lists (without connect/disconnect methods) #3479

ann0see commented Feb 13, 2025 •

edited

Loading

ann0see commented Feb 13, 2025

softins left a comment

mcfnord Feb 22, 2025

mcfnord Feb 22, 2025

mcfnord Feb 22, 2025 •

edited

Loading

mcfnord Feb 22, 2025

mcfnord Feb 22, 2025

mcfnord Feb 22, 2025 •

edited

Loading

mcfnord Feb 22, 2025

pljones Feb 23, 2025

riban-bw Feb 23, 2025

mcfnord Feb 22, 2025

mcfnord Feb 22, 2025

mcfnord Feb 22, 2025

ann0see left a comment

pljones Mar 1, 2025

ann0see Mar 7, 2025

	Request list of servers in a directory
	Request list of servers in a directory.

		@@ -129,6 +129,23 @@ Results:
		\| result.version \| string \| The Jamulus version. \|

	\| params.directory \| string \| socket address of directory to query, e.g. anygenre1.jamulus.io:22124. \|
	\| params.directory \| string \| Socket address of directory to query. Example: anygenre1.jamulus.io:22124. \|

	\| params.state \| number \| The recorder state \|
	\| params.state \| number \| The recorder state. \|

	\| params.address \| string \| The server socket address \|
	\| params.address \| string \| The server socket address. \|

	\| params.pingtime \| number \| The round-trip ping time in ms \|
	\| params.pingtime \| number \| The round-trip ping time, in milliseconds. \|

	\| params.numClients \| number \| The quantity of clients connected to the server \|
	\| params.numClients \| number \| The number of clients connected to the server. \|

	\| params.servers[*].address \| string \| Socket address (ip_address:port) \|
	\| params.servers[*].address \| string \| Socket address (ip_address:port). \|

	\| params.servers[*].name \| string \| Server name \|
	\| params.servers[*].name \| string \| Server name. \|

	\| params.servers[*].country \| string \| Server country \|
	\| params.servers[*].country \| string \| Server country. \|

Add JSON-RPC access to directories and server lists (without connect/disconnect methods) #3479

Are you sure you want to change the base?

Add JSON-RPC access to directories and server lists (without connect/disconnect methods) #3479

Conversation

ann0see commented Feb 13, 2025 • edited Loading

Checklist

ann0see commented Feb 13, 2025

softins left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mcfnord Feb 22, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mcfnord Feb 22, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ann0see left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ann0see commented Feb 13, 2025 •

edited

Loading

mcfnord Feb 22, 2025 •

edited

Loading

mcfnord Feb 22, 2025 •

edited

Loading