Document RPC method aliasing

Suggested by Sjors Provoost <sjors@sprovoost.nl> in
https://github.com/bitcoin/bitcoin/pull/11536#issuecomment-372820660
This commit is contained in:
Russell Yanofsky
2018-03-15 16:37:57 -04:00
parent 947c25ead2
commit 4c317d89e9
2 changed files with 20 additions and 0 deletions

View File

@@ -165,8 +165,17 @@ public:
/**
* Appends a CRPCCommand to the dispatch table.
*
* Returns false if RPC server is already running (dump concurrency protection).
*
* Commands cannot be overwritten (returns false).
*
* Commands with different method names but the same callback function will
* be considered aliases, and only the first registered method name will
* show up in the help text command listing. Aliased commands do not have
* to have the same behavior. Server and client code can distinguish
* between calls based on method name, and aliased commands can also
* register different names, types, and numbers of parameters.
*/
bool appendCommand(const std::string& name, const CRPCCommand* pcmd);
};