From 4c317d89e9d980328028ff01cd9a0465cc22bb7e Mon Sep 17 00:00:00 2001 From: Russell Yanofsky Date: Thu, 15 Mar 2018 16:37:57 -0400 Subject: Document RPC method aliasing Suggested by Sjors Provoost in https://github.com/bitcoin/bitcoin/pull/11536#issuecomment-372820660 --- src/rpc/server.h | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'src/rpc') diff --git a/src/rpc/server.h b/src/rpc/server.h index 8b32924fbc..d25268a8ab 100644 --- a/src/rpc/server.h +++ b/src/rpc/server.h @@ -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); }; -- cgit v1.2.3