From 37e19def3b7a62bce47fb292604fcb3efcbefd3b Mon Sep 17 00:00:00 2001 From: Michael Rotarius Date: Thu, 4 May 2017 21:09:38 +0200 Subject: [PATCH] Added GetMemoryInfo rpc command --- .../bitcoin-core/rpcs/rpcs/getmemoryinfo.md | 91 +++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 _includes/devdoc/bitcoin-core/rpcs/rpcs/getmemoryinfo.md diff --git a/_includes/devdoc/bitcoin-core/rpcs/rpcs/getmemoryinfo.md b/_includes/devdoc/bitcoin-core/rpcs/rpcs/getmemoryinfo.md new file mode 100644 index 00000000..e31a13d3 --- /dev/null +++ b/_includes/devdoc/bitcoin-core/rpcs/rpcs/getmemoryinfo.md @@ -0,0 +1,91 @@ +{% comment %} +This file is licensed under the MIT License (MIT) available on +http://opensource.org/licenses/MIT. +{% endcomment %} +{% assign filename="_includes/devdoc/bitcoin-core/rpcs/rpcs/getmemoryinfo.md" %} + +##### GetMemoryInfo +{% include helpers/subhead-links.md %} + +{% assign summary_getMemoryInfo="returns information about memory usage." %} + +{% autocrossref %} + +*Added in Bitcoin Core 0.14.0* + +The `getmemoryinfo` RPC {{summary_getMemoryInfo}} + +*Parameters: none* + +*Result---information about memory usage* + +{% itemplate ntpd1 %} +- n: "`result`" + t: "object" + p: "Required
(exactly 1)" + d: "An object containing information about memory usage" + +- n: "→
`locked`" + t: "string : object" + p: "Required
(exactly 1)" + d: "An object containing information about locked memory manager" + +- n: "→→
`used`" + t: "number (int)" + p: "Required
(exactly 1)" + d: "Number of bytes used" + +- n: "→→
`free`" + t: "number (int)" + p: "Required
(exactly 1)" + d: "Number of bytes available in current arenas" + +- n: "→→
`total`" + t: "number (int)" + p: "Required
(exactly 1)" + d: "Total number of bytes managed" + +- n: "→→
`locked`" + t: "number (int)" + p: "Required
(exactly 1)" + d: "Amount of bytes that succeeded locking" + +- n: "→→
`chunks_used`" + t: "number (int)" + p: "Required
(exactly 1)" + d: "Number allocated chunks" + +- n: "→→
`chunks_free`" + t: "number (int)" + p: "Required
(exactly 1)" + d: "Number unused chunks" + +{% enditemplate %} + +*Example from Bitcoin Core 0.14.1* + +{% highlight bash %} +bitcoin-cli getmemoryinfo +{% endhighlight %} + +Result: + +{% highlight json %} +{ + "locked": { + "used": 0, + "free": 65536, + "total": 65536, + "locked": 65536, + "chunks_used": 0, + "chunks_free": 1 + } +} + +{% endhighlight %} + +*See also* + +* [GetMemPoolInfo][rpc getmempoolinfo]: {{summary_getMemPoolInfo}} + +{% endautocrossref %}