kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-29 18:19:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move function SYSINFO documentation to XML.

Browse Source 
Move function SYSINFO static documentation to the new AstXML form.

(issue #15245)
Reported by: eliel
Patches:
      func_sysinfo_static_conversion.txt uploaded by lmadsen (license 10)



git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@199374 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Eliel C. Sardanons
2009-06-06 21:56:58 +00:00
parent a05f90e709
commit 65afefff9c
1 changed files with 51 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
funcs/func_sysinfo.c
View File

@@ -36,6 +36,57 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision: 87233 $")
#include "asterisk/module.h" #include "asterisk/module.h"
#include "asterisk/pbx.h" #include "asterisk/pbx.h"
/*** DOCUMENTATION
<function name="SYSINFO" language="en_US">
<synopsis>
Returns system information specified by parameter.
</synopsis>
<syntax>
<parameter name="parameter" required="true">
<enumlist>
<enum name="loadavg">
<para>System load average from past minute.</para>
</enum>
<enum name="numcalls">
<para>Number of active calls currently in progress.</para>
</enum>
<enum name="uptime">
<para>System uptime in hours.</para>
<note><para>This parameter is dependant upon operating system.</para></note>
</enum>
<enum name="totalram">
<para>Total usable main memory size in KiB.</para>
<note><para>This parameter is dependant upon operating system.</para></note>
</enum>
<enum name="freeram">
<para>Available memory size in KiB.</para>
<note><para>This parameter is dependant upon operating system.</para></note>
</enum>
<enum name="bufferram">
<para>Memory used by buffers in KiB.</para>
<note><para>This parameter is dependant upon operating system.</para></note>
</enum>
<enum name="totalswap">
<para>Total swap space still available in KiB.</para>
<note><para>This parameter is dependant upon operating system.</para></note>
</enum>
<enum name="freeswap">
<para>Free swap space still available in KiB.</para>
<note><para>This parameter is dependant upon operating system.</para></note>
</enum>
<enum name="numprocs">
<para>Number of current processes.</para>
<note><para>This parameter is dependant upon operating system.</para></note>
</enum>
</enumlist>
</parameter>
</syntax>
<description>
<para>Returns information from a given parameter.</para>
</description>
</function>
***/
static int sysinfo_helper(struct ast_channel *chan, const char *cmd, char *data, static int sysinfo_helper(struct ast_channel *chan, const char *cmd, char *data,
char *buf, size_t len) char *buf, size_t len)
{ {
@@ -83,24 +134,8 @@ static int sysinfo_helper(struct ast_channel *chan, const char *cmd, char *data,
static struct ast_custom_function sysinfo_function = { static struct ast_custom_function sysinfo_function = {
.name = "SYSINFO", .name = "SYSINFO",
.synopsis = "Returns system information specified by parameter.",
.syntax = "SYSINFO(<parameter>)",
.read = sysinfo_helper, .read = sysinfo_helper,
.read_max = 22, .read_max = 22,
.desc =
"Returns information from a given parameter\n"
" Options:\n"
" loadavg - system load average from past minute\n"
" numcalls - number of active calls currently in progress\n"
#if defined(HAVE_SYSINFO)
" uptime - system uptime in hours\n"
" totalram - total usable main memory size in KiB\n"
" freeram - available memory size in KiB\n"
" bufferram - memory used by buffers in KiB\n"
" totalswap - total swap space size in KiB\n"
" freeswap - free swap space still available in KiB\n"
" numprocs - number of current processes\n",
#endif /* HAVE_SYSINFO */
}; };
static int unload_module(void) static int unload_module(void)