[svn-commits] eliel: branch group/appdocsxml r146405 - /team/group/appdocsxml/funcs/
SVN commits to the Digium repositories
svn-commits at lists.digium.com
Sat Oct 4 16:05:53 CDT 2008
Author: eliel
Date: Sat Oct 4 16:05:53 2008
New Revision: 146405
URL: http://svn.digium.com/view/asterisk?view=rev&rev=146405
Log:
Introduce CHANNEL() and CHANNELS() functions XML documentation.
Modified:
team/group/appdocsxml/funcs/func_channel.c
team/group/appdocsxml/funcs/func_cut.c
Modified: team/group/appdocsxml/funcs/func_channel.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/funcs/func_channel.c?view=diff&rev=146405&r1=146404&r2=146405
==============================================================================
--- team/group/appdocsxml/funcs/func_channel.c (original)
+++ team/group/appdocsxml/funcs/func_channel.c Sat Oct 4 16:05:53 2008
@@ -37,6 +37,107 @@
#include "asterisk/app.h"
#include "asterisk/indications.h"
#include "asterisk/stringfields.h"
+
+/*** DOCUMENTATION
+ <function name="CHANNELS" language="en_US">
+ <synopsis>
+ Gets the list of channels, optionally filtering by a regular expression.
+ </synopsis>
+ <syntax>
+ <parameter name="regular_expression" />
+ </syntax>
+ <description>
+ <para>Gets the list of channels, optionally filtering by a <replaceable>regular_expression</replaceable>. If
+ no argument is provided, all known channels are returned. The
+ <replaceable>regular_expression</replaceable> must correspond to
+ the POSIX.2 specification, as shown in <emphasis>regex(7)</emphasis>. The list returned
+ will be space-delimited.</para>
+ </description>
+ </function>
+ <function name="CHANNEL" language="en_US">
+ <synopsis>
+ Gets/sets various pieces of information about the channel.
+ </synopsis>
+ <syntax>
+ <parameter name="item" required="true">
+ <para>Standard items (provided by all channel technologies) are:</para>
+ <para>R/O <literal>audioreadformat</literal> format currently being read</para>
+ <para>R/O <literal>audionativeformat</literal> format used natively for audio</para>
+ <para>R/O <literal>audiowriteformat</literal> format currently being written</para>
+ <para>R/W <literal>callgroup</literal> call groups for call pickup</para>
+ <para>R/O <literal>channeltype</literal> technology used for channel</para>
+ <para>R/W <literal>language</literal> language for sounds played</para>
+ <para>R/W <literal>musicclass</literal> class (from musiconhold.conf) for hold music</para>
+ <para>R/W <literal>parkinglot</literal> parkinglot for parking</para>
+ <para>R/W <literal>rxgain</literal> set rxgain level on channel drivers that support it</para>
+ <para>R/O <literal>state</literal> state for channel</para>
+ <para>R/W <literal>tonezone</literal> zone for indications played</para>
+ <para>R/W <literal>txgain</literal> set txgain level on channel drivers that support it</para>
+ <para>R/O <literal>videonativeformat</literal> format used natively for video</para>
+ <para>R/W <literal>trace</literal> whether or not context tracing is enabled</para>
+ <para><emphasis>chan_sip</emphasis> provides the following additional options:</para>
+ <para>R/O <literal>peerip</literal> Get the IP address of the peer</para>
+ <para>R/O <literal>recvip</literal> Get the source IP address of the peer</para>
+ <para>R/O <literal>from</literal> Get the URI from the From: header</para>
+ <para>R/O <literal>uri</literal> Get the URI from the Contact: header</para>
+ <para>R/O <literal>useragent</literal> Get the useragent</para>
+ <para>R/O <literal>peername</literal> Get the name of the peer</para>
+ <para>R/O <literal>t38passthrough</literal> 1 if T38 is offered or enabled in this channel, otherwise 0</para>
+ <para>R/O <literal>rtpqos</literal> Get QOS information about the RTP stream</para>
+ <para> This option takes two additional arguments:</para>
+ <para> Argument 1:</para>
+ <para> <literal>audio</literal> Get data about the audio stream</para>
+ <para> <literal>video</literal> Get data about the video stream</para>
+ <para> <literal>text</literal> Get data about the text stream</para>
+ <para> Argument 2:</para>
+ <para> <literal>local_ssrc</literal> Local SSRC (stream ID)</para>
+ <para> <literal>local_lostpackets</literal> Local lost packets</para>
+ <para> <literal>local_jitter</literal> Local calculated jitter</para>
+ <para> <literal>local_maxjitter</literal> Local calculated jitter (maximum)</para>
+ <para> <literal>local_minjitter</literal> Local calculated jitter (minimum)</para>
+ <para> <literal>local_normdevjitter</literal>Local calculated jitter (normal deviation)</para>
+ <para> <literal>local_stdevjitter</literal> Local calculated jitter (standard deviation)</para>
+ <para> <literal>local_count</literal> Number of received packets</para>
+ <para> <literal>remote_ssrc</literal> Remote SSRC (stream ID)</para>
+ <para> <literal>remote_lostpackets</literal>Remote lost packets</para>
+ <para> <literal>remote_jitter</literal> Remote reported jitter</para>
+ <para> <literal>remote_maxjitter</literal> Remote calculated jitter (maximum)</para>
+ <para> <literal>remote_minjitter</literal> Remote calculated jitter (minimum)</para>
+ <para> <literal>remote_normdevjitter</literal>Remote calculated jitter (normal deviation)</para>
+ <para> <literal>remote_stdevjitter</literal>Remote calculated jitter (standard deviation)</para>
+ <para> <literal>remote_count</literal> Number of transmitted packets</para>
+ <para> <literal>remote_ssrc</literal> Remote SSRC (stream ID)</para>
+ <para> <literal>remote_lostpackets</literal>Remote lost packets</para>
+ <para> <literal>remote_jitter</literal> Remote reported jitter</para>
+ <para> <literal>remote_maxjitter</literal> Remote calculated jitter (maximum)</para>
+ <para> <literal>remote_minjitter</literal> Remote calculated jitter (minimum)</para>
+ <para> <literal>remote_normdevjitter</literal>Remote calculated jitter (normal deviation)</para>
+ <para> <literal>remote_stdevjitter</literal>Remote calculated jitter (standard deviation)</para>
+ <para> <literal>remote_count</literal> Number of transmitted packets</para>
+ <para> <literal>rtt</literal> Round trip time</para>
+ <para> <literal>maxrtt</literal> Round trip time (maximum)</para>
+ <para> <literal>minrtt</literal> Round trip time (minimum)</para>
+ <para> <literal>normdevrtt</literal> Round trip time (normal deviation)</para>
+ <para> <literal>stdevrtt</literal> Round trip time (standard deviation)</para>
+ <para> <literal>all</literal> All statistics (in a form suited to logging, but not for parsing)</para>
+ <para>R/O <literal>rtpdest</literal> Get remote RTP destination information</para>
+ <para> This option takes one additional argument:</para>
+ <para> Argument 1:</para>
+ <para> <literal>audio</literal> Get audio destination</para>
+ <para> <literal>video</literal> Get video destination</para>
+ <para><emphasis>chan_iax2</emphasis> provides the following additional options:</para>
+ <para>R/W <literal>osptoken</literal> Get or set the OSP token information for a call</para>
+ <para>R/O <literal>peerip</literal> Get the peer's ip address</para>
+ <para>R/O <literal>peername</literal> Get the peer's username</para>
+ </parameter>
+ </syntax>
+ <description>
+ <para>Gets/sets various pieces of information about the channel, additional <replaceable>item</replaceable> may
+ be available from the channel driver; see its documentation for details. Any <replaceable>item</replaceable>
+ requested that is not available on the current channel will return an empty string.</para>
+ </description>
+ </function>
+ ***/
#define locked_copy_string(chan, dest, source, len) \
do { \
@@ -168,80 +269,6 @@
static struct ast_custom_function channel_function = {
.name = "CHANNEL",
- .synopsis = "Gets/sets various pieces of information about the channel.",
- .syntax = "CHANNEL(item)",
- .desc = "Gets/set various pieces of information about the channel.\n"
- "Standard items (provided by all channel technologies) are:\n"
- "R/O audioreadformat format currently being read\n"
- "R/O audionativeformat format used natively for audio\n"
- "R/O audiowriteformat format currently being written\n"
- "R/W callgroup call groups for call pickup\n"
- "R/O channeltype technology used for channel\n"
- "R/W language language for sounds played\n"
- "R/W musicclass class (from musiconhold.conf) for hold music\n"
- "R/W parkinglot parkinglot for parking\n"
- "R/W rxgain set rxgain level on channel drivers that support it\n"
- "R/O state state for channel\n"
- "R/W tonezone zone for indications played\n"
- "R/W txgain set txgain level on channel drivers that support it\n"
- "R/O videonativeformat format used natively for video\n"
-#ifdef CHANNEL_TRACE
- "R/W trace whether or not context tracing is enabled\n"
-#endif
- "\n"
- "chan_sip provides the following additional options:\n"
- "R/O peerip Get the IP address of the peer\n"
- "R/O recvip Get the source IP address of the peer\n"
- "R/O from Get the URI from the From: header\n"
- "R/O uri Get the URI from the Contact: header\n"
- "R/O useragent Get the useragent\n"
- "R/O peername Get the name of the peer\n"
- "R/O t38passthrough 1 if T38 is offered or enabled in this channel, otherwise 0\n"
- "R/O rtpqos Get QOS information about the RTP stream\n"
- " This option takes two additional arguments:\n"
- " Argument 1:\n"
- " audio Get data about the audio stream\n"
- " video Get data about the video stream\n"
- " text Get data about the text stream\n"
- " Argument 2:\n"
- " local_ssrc Local SSRC (stream ID)\n"
- " local_lostpackets Local lost packets\n"
- " local_jitter Local calculated jitter\n"
- " local_maxjitter Local calculated jitter (maximum)\n"
- " local_minjitter Local calculated jitter (minimum)\n"
- " local_normdevjitter Local calculated jitter (normal deviation)\n"
- " local_stdevjitter Local calculated jitter (standard deviation)\n"
- " local_count Number of received packets\n"
- " remote_ssrc Remote SSRC (stream ID)\n"
- " remote_lostpackets Remote lost packets\n"
- " remote_jitter Remote reported jitter\n"
- " remote_maxjitter Remote calculated jitter (maximum)\n"
- " remote_minjitter Remote calculated jitter (minimum)\n"
- " remote_normdevjitter Remote calculated jitter (normal deviation)\n"
- " remote_stdevjitter Remote calculated jitter (standard deviation)\n"
- " remote_count Number of transmitted packets\n"
- " rtt Round trip time\n"
- " maxrtt Round trip time (maximum)\n"
- " minrtt Round trip time (minimum)\n"
- " normdevrtt Round trip time (normal deviation)\n"
- " stdevrtt Round trip time (standard deviation)\n"
- " all All statistics (in a form suited to logging, but not for parsing)\n"
- "R/O rtpdest Get remote RTP destination information\n"
- " This option takes one additional argument:\n"
- " Argument 1:\n"
- " audio Get audio destination\n"
- " video Get video destination\n"
- "\n"
- "chan_iax2 provides the following additional options:\n"
- "R/W osptoken Get or set the OSP token information for a call\n"
- "R/O peerip Get the peer's ip address\n"
- "R/O peername Get the peer's username\n"
- "\n"
- "Additional items may be available from the channel driver providing\n"
- "the channel; see its documentation for details.\n"
- "\n"
- "Any item requested that is not available on the current channel will\n"
- "return an empty string.\n",
.read = func_channel_read,
.write = func_channel_write,
};
@@ -288,13 +315,6 @@
static struct ast_custom_function channels_function = {
.name = "CHANNELS",
- .synopsis = "Gets the list of channels, optionally filtering by a regular expression.",
- .syntax = "CHANNEL([regular expression])",
- .desc =
-"Gets the list of channels, optionally filtering by a regular expression. If\n"
-"no argument is provided, all known channels are returned. The regular\n"
-"expression must correspond to the POSIX.2 specification, as shown in\n"
-"regex(7). The list returned will be space-delimited.\n",
.read = func_channels_read,
};
Modified: team/group/appdocsxml/funcs/func_cut.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/funcs/func_cut.c?view=diff&rev=146405&r1=146404&r2=146405
==============================================================================
--- team/group/appdocsxml/funcs/func_cut.c (original)
+++ team/group/appdocsxml/funcs/func_cut.c Sat Oct 4 16:05:53 2008
@@ -35,7 +35,6 @@
#include "asterisk/app.h"
/*** DOCUMENTATION
-
<function name="SORT" language="en_US">
<synopsis>
Sorts a list of key/vals into a list of keys, based upon the vals.
More information about the svn-commits
mailing list