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 |
|---|---|---|
|
|
@@ -54,8 +54,10 @@ CClientRpc::CClientRpc ( CClient* pClient, CRpcServer* pRpcServer, QObject* pare | |
| /// @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 {number} params.clients[*].countryId - The musician’s country ID (see QLocale::Country). | ||
| /// @param {string} params.clients[*].country - The musician’s country. | ||
| /// @param {string} params.clients[*].city - The musician’s city. | ||
| /// @param {number} params.clients[*].instrumentId - The musician’s instrument ID (see CInstPictures::GetTable). | ||
| /// @param {string} params.clients[*].instrument - The musician’s instrument. | ||
| connect ( pClient, &CClient::ConClientListMesReceived, [=] ( CVector<CChannelInfo> vecChanInfo ) { | ||
| QJsonArray arrChanInfo; | ||
| for ( const auto& chanInfo : vecChanInfo ) | ||
|
|
@@ -65,8 +67,10 @@ CClientRpc::CClientRpc ( CClient* pClient, CRpcServer* pRpcServer, QObject* pare | |
| { "name", chanInfo.strName }, | ||
| { "skillLevel", SerializeSkillLevel ( chanInfo.eSkillLevel ) }, | ||
| { "countryId", chanInfo.eCountry }, | ||
| { "country", QLocale::countryToString ( chanInfo.eCountry ) }, | ||
| { "city", chanInfo.strCity }, | ||
| { "instrumentId", chanInfo.iInstrument }, | ||
| { "instrument", CInstPictures::GetName ( chanInfo.iInstrument ) }, | ||
| }; | ||
| arrChanInfo.append ( objChanInfo ); | ||
| } | ||
|
|
@@ -94,11 +98,127 @@ 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 {number} params.servers[*].countryId - Server country ID (see QLocale::Country). | ||
| /// @param {string} params.servers[*].country - Server country | ||
| /// @param {string} params.servers[*].city - Server city | ||
| connect ( pClient->getConnLessProtocol(), | ||
| &CProtocol::CLServerListReceived, | ||
|
There was a problem hiding this comment. How often is an RPC client going to receive this message? Given the nature of the server list (i.e. it's not guaranteed to be in any particular order or even complete), in what use cases would this message be consumed? (Just thinking the JSON RPC doc might be expanded to explain - it's a bit brief currently.) There was a problem hiding this comment. The list seems to be sent only after being requested by the poll. I am using it to populate a list as required on the basis that the list will be accurate at that time. It seems to work well. There was a problem hiding this comment. It also gets issued if the connect dialog is open. |
||
| [=] ( CHostAddress /* unused */, CVector<CServerInfo> vecServerInfo ) { | ||
| QJsonArray arrServerInfo; | ||
| for ( const auto& serverInfo : vecServerInfo ) | ||
| { | ||
| QJsonObject objServerInfo{ | ||
| { "address", serverInfo.HostAddr.toString() }, | ||
| { "name", serverInfo.strName }, | ||
| { "countryId", serverInfo.eCountry }, | ||
| { "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 Connect client to server | ||
| /// @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; | ||
| } | ||
|
|
||
ann0see marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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"; | ||
ann0see marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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). | ||
|
|
@@ -126,16 +246,20 @@ CClientRpc::CClientRpc ( CClient* pClient, CRpcServer* pRpcServer, QObject* pare | |
| /// @result {string} result.name - The musician’s name. | ||
| /// @result {string} result.skillLevel - The musician’s skill level (beginner, intermediate, expert, or null). | ||
| /// @result {number} result.countryId - The musician’s country ID (see QLocale::Country). | ||
| /// @result {string} result.country - The musician’s country. | ||
| /// @result {string} result.city - The musician’s city. | ||
| /// @result {number} result.instrumentId - The musician’s instrument ID (see CInstPictures::GetTable). | ||
| /// @result {string} 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 as pClient->ChannelInfo is a CChannelCoreInfo which lacks that field. | ||
| { "name", pClient->ChannelInfo.strName }, | ||
| { "countryId", pClient->ChannelInfo.eCountry }, | ||
| { "country", QLocale::countryToString ( pClient->ChannelInfo.eCountry ) }, | ||
| { "city", pClient->ChannelInfo.strCity }, | ||
| { "instrumentId", pClient->ChannelInfo.iInstrument }, | ||
| { "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.
Surely this is