diff options
author | eliel <eliel@f38db490-d61c-443f-a65b-d21fe96a405b> | 2009-05-22 17:52:35 +0000 |
---|---|---|
committer | eliel <eliel@f38db490-d61c-443f-a65b-d21fe96a405b> | 2009-05-22 17:52:35 +0000 |
commit | cbbfdc573c6f071b12dc665273c0063a0c69ad69 (patch) | |
tree | e1c6ca80d913c0e0aa3166a40d7b8e4461cd62d1 /channels/chan_iax2.c | |
parent | c208610d90db5a241e187413c831309cd5f13f32 (diff) |
Implement a new element in AstXML for AMI actions documentation.
A new xml element was created to manage the AMI actions documentation,
using AstXML.
To register a manager action using XML documentation it is now possible
using ast_manager_register_xml().
The CLI command 'manager show command' can be used to show the parsed
documentation.
Example manager xml documentation:
<manager name="ami action name" language="en_US">
<synopsis>
AMI action synopsis.
</synopsis>
<syntax>
<xi:include xpointer="xpointer(...)" /> <-- for ActionID
<parameter name="header1" required="true">
<para>Description</para>
</parameter>
...
</syntax>
<description>
<para>AMI action description</para>
</description>
<see-also>
...
</see-also>
</manager>
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@196308 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'channels/chan_iax2.c')
-rw-r--r-- | channels/chan_iax2.c | 49 |
1 files changed, 45 insertions, 4 deletions
diff --git a/channels/chan_iax2.c b/channels/chan_iax2.c index 383f97ed9..e6e1280cc 100644 --- a/channels/chan_iax2.c +++ b/channels/chan_iax2.c @@ -175,6 +175,47 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") </syntax> <description /> </function> + <manager name="IAXpeers" language="en_US"> + <synopsis> + List IAX peers. + </synopsis> + <syntax> + <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" /> + </syntax> + <description> + </description> + </manager> + <manager name="IAXpeerlist" language="en_US"> + <synopsis> + List IAX Peers. + </synopsis> + <syntax> + <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" /> + </syntax> + <description> + <para>List all the IAX peers.</para> + </description> + </manager> + <manager name="IAXnetstats" language="en_US"> + <synopsis> + Show IAX Netstats. + </synopsis> + <syntax /> + <description> + <para>Show IAX channels network statistics.</para> + </description> + </manager> + <manager name="IAXregistry" language="en_US"> + <synopsis> + Show IAX registrations. + </synopsis> + <syntax> + <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" /> + </syntax> + <description> + <para>Show IAX registrations.</para> + </description> + </manager> ***/ /* Define SCHED_MULTITHREADED to run the scheduler in a special @@ -12720,10 +12761,10 @@ static int load_module(void) ast_register_application_xml(papp, iax2_prov_app); - ast_manager_register( "IAXpeers", EVENT_FLAG_SYSTEM | EVENT_FLAG_REPORTING, manager_iax2_show_peers, "List IAX Peers" ); - ast_manager_register( "IAXpeerlist", EVENT_FLAG_SYSTEM | EVENT_FLAG_REPORTING, manager_iax2_show_peer_list, "List IAX Peers" ); - ast_manager_register( "IAXnetstats", EVENT_FLAG_SYSTEM | EVENT_FLAG_REPORTING, manager_iax2_show_netstats, "Show IAX Netstats" ); - ast_manager_register( "IAXregistry", EVENT_FLAG_SYSTEM | EVENT_FLAG_REPORTING, manager_iax2_show_registry, "Show IAX registrations"); + ast_manager_register_xml("IAXpeers", EVENT_FLAG_SYSTEM | EVENT_FLAG_REPORTING, manager_iax2_show_peers); + ast_manager_register_xml("IAXpeerlist", EVENT_FLAG_SYSTEM | EVENT_FLAG_REPORTING, manager_iax2_show_peer_list); + ast_manager_register_xml("IAXnetstats", EVENT_FLAG_SYSTEM | EVENT_FLAG_REPORTING, manager_iax2_show_netstats); + ast_manager_register_xml("IAXregistry", EVENT_FLAG_SYSTEM | EVENT_FLAG_REPORTING, manager_iax2_show_registry); if ((timer = ast_timer_open())) { ast_timer_set_rate(timer, trunkfreq); |