Add JSON-RPC access to directories and server lists. #3249
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -53,9 +53,9 @@ CClientRpc::CClientRpc ( CClient* pClient, CRpcServer* pRpcServer, QObject* pare | |||||
| /// @param {number} params.clients[*].id - The channel ID. | ||||||
| /// @param {string} params.clients[*].name - The musician’s name. | ||||||
| /// @param {string} params.clients[*].skillLevel - The musician’s skill level (beginner, intermediate, expert, or null). | ||||||
| /// @param {string} params.clients[*].country - The musician’s country. | ||||||
| /// @param {string} params.clients[*].city - The musician’s city. | ||||||
| /// @param {string} params.clients[*].instrument - The musician’s instrument. | ||||||
| connect ( pClient, &CClient::ConClientListMesReceived, [=] ( CVector<CChannelInfo> vecChanInfo ) { | ||||||
| QJsonArray arrChanInfo; | ||||||
| for ( const auto& chanInfo : vecChanInfo ) | ||||||
|
|
@@ -64,9 +64,9 @@ CClientRpc::CClientRpc ( CClient* pClient, CRpcServer* pRpcServer, QObject* pare | |||||
| { "id", chanInfo.iChanID }, | ||||||
| { "name", chanInfo.strName }, | ||||||
| { "skillLevel", SerializeSkillLevel ( chanInfo.eSkillLevel ) }, | ||||||
| { "country", QLocale::countryToString ( chanInfo.eCountry ) }, | ||||||
| { "city", chanInfo.strCity }, | ||||||
| { "instrument", CInstPictures::GetName ( chanInfo.iInstrument ) }, | ||||||
| }; | ||||||
| arrChanInfo.append ( objChanInfo ); | ||||||
| } | ||||||
|
|
@@ -94,11 +94,131 @@ CClientRpc::CClientRpc ( CClient* pClient, CRpcServer* pRpcServer, QObject* pare | |||||
| } ); | ||||||
| } ); | ||||||
|
|
||||||
| /// @rpc_notification jamulusclient/serverListReceived | ||||||
| /// @brief Emitted when the server list is received. | ||||||
| /// @param {array} params.servers - The server list. | ||||||
| /// @param {string} params.servers[*].address - Socket address (ip_address:port) | ||||||
| /// @param {string} params.servers[*].name - Server name | ||||||
| /// @param {string} params.servers[*].country - Server country | ||||||
| /// @param {string} params.servers[*].city - Server city | ||||||
| connect ( pClient->getConnLessProtocol(), &CProtocol::CLServerListReceived, [=] ( CHostAddress /* unused */, CVector<CServerInfo> vecServerInfo ) { | ||||||
| QJsonArray arrServerInfo; | ||||||
| for ( const auto& serverInfo : vecServerInfo ) | ||||||
| { | ||||||
| QJsonObject objServerInfo{ | ||||||
| { "address", serverInfo.HostAddr.toString() }, | ||||||
| { "name", serverInfo.strName }, | ||||||
| { "country", QLocale::countryToString ( serverInfo.eCountry) }, | ||||||
| { "city", serverInfo.strCity }, | ||||||
| }; | ||||||
| arrServerInfo.append ( objServerInfo ); | ||||||
| pClient->CreateCLServerListPingMes ( serverInfo.HostAddr ); | ||||||
| } | ||||||
| pRpcServer->BroadcastNotification ( "jamulusclient/serverListReceived", | ||||||
| QJsonObject{ | ||||||
| { "servers", arrServerInfo }, | ||||||
| } ); | ||||||
| } ); | ||||||
|
|
||||||
| /// @rpc_notification jamulusclient/serverInfoReceived | ||||||
| /// @brief Emitted when a server info is received. | ||||||
| /// @param {string} params.address - The server socket address | ||||||
| /// @param {number} params.pingtime - The round-trip ping time in ms | ||||||
| /// @param {number} params.numClients - The quantity of clients connected to the server | ||||||
| connect (pClient, &CClient::CLPingTimeWithNumClientsReceived, [=] ( CHostAddress InetAddr, int iPingTime, int iNumClients ) { | ||||||
| pRpcServer->BroadcastNotification ( "jamulusclient/serverInfoReceived", | ||||||
| QJsonObject{ | ||||||
| {"address", InetAddr.toString()}, | ||||||
| {"pingTime", iPingTime}, | ||||||
| {"numClients", iNumClients} | ||||||
| } ); | ||||||
| } ); | ||||||
|
|
||||||
| /// @rpc_notification jamulusclient/disconnected | ||||||
| /// @brief Emitted when the client is disconnected from the server. | ||||||
| /// @param {object} params - No parameters (empty object). | ||||||
| connect ( pClient, &CClient::Disconnected, [=]() { pRpcServer->BroadcastNotification ( "jamulusclient/disconnected", QJsonObject{} ); } ); | ||||||
|
|
||||||
| /// @rpc_notification jamulusclient/recorderState | ||||||
| /// @brief Emitted when the client is connected to a server who's recorder state changes. | ||||||
| /// @param {number} params.state - The recorder state | ||||||
| connect ( pClient, &CClient::RecorderStateReceived, [=] ( const ERecorderState newRecorderState ) { | ||||||
| pRpcServer->BroadcastNotification ( "jamulusclient/recorderState", | ||||||
| QJsonObject{ | ||||||
| {"state", newRecorderState} | ||||||
| } ); | ||||||
| } ); | ||||||
|
|
||||||
| /// @rpc_method jamulus/pollServerList | ||||||
| /// @brief Request list of servers in a directory | ||||||
| /// @param {string} params.directory - socket address of directory to query, e.g. anygenre1.jamulus.io:22124. | ||||||
| /// @result {string} result - "ok" or "error" if bad arguments. | ||||||
| pRpcServer->HandleMethod ( "jamulusclient/pollServerList", [=] ( const QJsonObject& params, QJsonObject& response ) { | ||||||
| auto jsonDirectoryIp = params["directory"]; | ||||||
| if ( !jsonDirectoryIp.isString() ) | ||||||
| { | ||||||
| response["error"] = CRpcServer::CreateJsonRpcError ( CRpcServer::iErrInvalidParams, "Invalid params: directory is not a string" ); | ||||||
riban-bw marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| return; | ||||||
| } | ||||||
|
|
||||||
| CHostAddress haDirectoryAddress; | ||||||
| if ( NetworkUtil().ParseNetworkAddress ( | ||||||
| jsonDirectoryIp.toString(), | ||||||
| haDirectoryAddress, | ||||||
| false ) ) | ||||||
| { | ||||||
| // send the request for the server list | ||||||
| pClient->CreateCLReqServerListMes( haDirectoryAddress ); | ||||||
| response["result"] = "ok"; | ||||||
| } | ||||||
| else | ||||||
| { | ||||||
| response["error"] = CRpcServer::CreateJsonRpcError ( CRpcServer::iErrInvalidParams, "Invalid params: directory is not a valid socket address" ); | ||||||
| } | ||||||
|
|
||||||
| response["result"] = "ok"; | ||||||
| } ); | ||||||
|
|
||||||
| /// @rpc_method jamulusclient/connect | ||||||
| /// @brief Disconnect client from server | ||||||
|
There was a problem hiding this comment. The documentation is wrong.
Suggested change
|
||||||
| /// @param {string} params.address - Server socket address (ip_addr:port). | ||||||
| /// @result {string} result - Always "ok". | ||||||
| pRpcServer->HandleMethod ( "jamulusclient/connect", [=] ( const QJsonObject& params, QJsonObject& response ) { | ||||||
| auto jsonAddr = params["address"]; | ||||||
| if ( !jsonAddr.isString() ) | ||||||
| { | ||||||
| response["error"] = CRpcServer::CreateJsonRpcError ( CRpcServer::iErrInvalidParams, "Invalid params: address is not a string" ); | ||||||
| return; | ||||||
| } | ||||||
|
|
||||||
|
There was a problem hiding this comment. See Line 1196 in e12cb71 |
||||||
| if ( pClient->SetServerAddr(jsonAddr.toString()) ) | ||||||
| { | ||||||
| if ( !pClient->IsRunning() ) | ||||||
| { | ||||||
| pClient->Start(); | ||||||
| } | ||||||
| response["result"] = "ok"; | ||||||
| } | ||||||
| else | ||||||
| { | ||||||
| response["error"] = CRpcServer::CreateJsonRpcError ( 1, "Bad server address" ); | ||||||
| } | ||||||
| } ); | ||||||
|
|
||||||
| /// @rpc_method jamulusclient/disconnect | ||||||
| /// @brief Disconnect client from server | ||||||
| /// @param {object} params - No parameters (empty object). | ||||||
| /// @result {string} result - Always "ok". | ||||||
| pRpcServer->HandleMethod ( "jamulusclient/disconnect", [=] ( const QJsonObject& params, QJsonObject& response ) { | ||||||
| if ( pClient->IsRunning() ) | ||||||
| { | ||||||
| pClient->Stop(); | ||||||
|
There was a problem hiding this comment. I believe that this should call Disconnect() here instead Line 1244 in e12cb71 There was a problem hiding this comment. Nothing should call Dialog methods, except internally. Ever. The Dialog UI might not exist if th RPC interface is in use. There was a problem hiding this comment. We need to update the UI somehow. -> refactoring needed. There was a problem hiding this comment. Yes. If a change to state happens to the Client ( |
||||||
| } | ||||||
|
|
||||||
| response["result"] = "ok"; | ||||||
|
There was a problem hiding this comment. Why is this always ok and not an error if this is called on an already disconnected client? There was a problem hiding this comment. I was only following similar code elsewhere in the interface. A common question is whether we want an error when we ask for an action and the action gives the desired effect, e.g. disconnect from a device to which we are not connected results in being disconnected. Is this erroneous? I would guess other places this same, alway "ok" result is used here allows such an action that will never fail to give an acknowledgement that the request was recevied and actioned. There was a problem hiding this comment. Ok. Then we can leave it as is. |
||||||
| Q_UNUSED ( params ); | ||||||
| } ); | ||||||
|
|
||||||
| /// @rpc_method jamulus/getMode | ||||||
| /// @brief Returns the current mode, i.e. whether Jamulus is running as a server or client. | ||||||
| /// @param {object} params - No parameters (empty object). | ||||||
|
|
@@ -125,17 +245,17 @@ CClientRpc::CClientRpc ( CClient* pClient, CRpcServer* pRpcServer, QObject* pare | |||||
| /// @result {number} result.id - The channel ID. | ||||||
| /// @result {string} result.name - The musician’s name. | ||||||
| /// @result {string} result.skillLevel - The musician’s skill level (beginner, intermediate, expert, or null). | ||||||
| /// @result {string} result.country - The musician’s country. | ||||||
| /// @result {string} result.city - The musician’s city. | ||||||
| /// @result {number} result.instrument - The musician’s instrument. | ||||||
| /// @result {string} result.skillLevel - Your skill level (beginner, intermediate, expert, or null). | ||||||
| pRpcServer->HandleMethod ( "jamulusclient/getChannelInfo", [=] ( const QJsonObject& params, QJsonObject& response ) { | ||||||
| QJsonObject result{ | ||||||
| // TODO: We cannot include "id" here is pClient->ChannelInfo is a CChannelCoreInfo which lacks that field. | ||||||
|
There was a problem hiding this comment. Typo, but not your issue.
Suggested change
|
||||||
| { "name", pClient->ChannelInfo.strName }, | ||||||
| { "country", QLocale::countryToString ( pClient->ChannelInfo.eCountry ) }, | ||||||
| { "city", pClient->ChannelInfo.strCity }, | ||||||
| { "instrument", CInstPictures::GetName ( pClient->ChannelInfo.iInstrument ) }, | ||||||
| { "skillLevel", SerializeSkillLevel ( pClient->ChannelInfo.eSkillLevel ) }, | ||||||
| }; | ||||||
| response["result"] = result; | ||||||
|
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for my forgetfulness here - you need to update the python script I mentioned below and not edit the file directly
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have run the script and pushed the changes.