Added GetMemoryInfo rpc command

This commit is contained in:
Michael Rotarius 2017-05-04 21:09:38 +02:00
parent ca060f00c8
commit 37e19def3b

View file

@ -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<br>(exactly 1)"
d: "An object containing information about memory usage"
- n: "→<br>`locked`"
t: "string : object"
p: "Required<br>(exactly 1)"
d: "An object containing information about locked memory manager"
- n: "→→<br>`used`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "Number of bytes used"
- n: "→→<br>`free`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "Number of bytes available in current arenas"
- n: "→→<br>`total`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "Total number of bytes managed"
- n: "→→<br>`locked`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "Amount of bytes that succeeded locking"
- n: "→→<br>`chunks_used`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "Number allocated chunks"
- n: "→→<br>`chunks_free`"
t: "number (int)"
p: "Required<br>(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 %}