Add new RPC methods and notifications (mostly for scripting interaction) to server and client

[dingodoppelt]

Short description of changes

Add the following RPC methods and notifications to server and client. These are useful mostly for scripting interaction.

• jamulus/getAvailableMethods
• jamulusclient/setMuted
• jamulusserver/broadcastChatMessage
• jamulusserver/getClientDetails
• jamulusserver/chatMessageReceived
• jamulusserver/clientConnected
• jamulusserver/clientDisconnected
• jamulusserver/privateChatMessage

CHANGELOG: Add new RPC methods and notifications (mostly for scripting interaction) to server and client

Context: Fixes an issue?

Relates to #3029 #3447 #2828 #1057 #1371
This is needed for Jamban and others.

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

I guess the automated RPC documentation is sufficient?

Status of this Pull Request
up for discussion

What is missing until this pull request can be merged?
Approval

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

[ann0see]

@mcfnord you might be interested in this.

[pljones]

Suggested change

	Sends a chat message to all connected clients.
	Sends a chat message from this client to the server. The server will send this to all connected clients.

[dingodoppelt]

What exactly is "this client" in this case? Should'nt it rather be "this RPC client" (like nc, curl or some script)? Since this is a server method I think my explanation is sufficient in making clear what this method does.

[pljones]

The Client in Jamulus terms is the Client exchanging UDP messages with the Server. (I should have capitalised both for compliance with the style guide, my bad.)

Maybe

Suggested change

	Sends a chat message to all connected clients.
	Sends the chat message in the request from the Client to the Server. The Service will send the message to all connected Clients.

[dingodoppelt]

The Client in Jamulus terms is the Client exchanging UDP messages with the Server.

But we are not a client in this case, we are the RPC server and we are processing a request from a client like curl or nc. I'm confused

Edit: To clarify: this is a server method, not client. This is not the client sending a normal chat message just triggered via RPC, it is actually the server itself broadcasting a message to all connected clients.

[pljones]

Ah right. I missed that, sorry. Still, make the doc clearer 😄 .

[pljones]

Needs splitting. The private message feature should be separate.

[dingodoppelt]

Needs splitting. The private message feature should be separate.

In addition to jamulusserver/broadcastChatMessage and jamulusserver/chatMessageReceived I think this is the right place for it, tbh. It would make more sense to split the whole PR into three smaller ones

1. Chat
2. Client connection/disconnection
3. set client muted status

but I don't see why only the private chat message should be handled independently.

[pljones]

but I don't see why only the private chat message should be handled independently.

Because the feature is entirely new.