Makefile: Allow XML documentation to exist outside source files
Moved the xmldoc build logic from the top-level Makefile into
its own script "make_xml_documentation" in the build_tools
directory.
Created a new utility script "get_sourceable_makeopts", also in
the build_tools directory, that dumps the top-level "makeopts"
file in a format that can be "sourced" from shell sscripts.
This allows scripts to easily get the values of common make
build variables such as the location of the GREP, SED, AWK, etc.
utilities as well as the AST* and library *_LIB and *_INCLUDE
variables.
Besides moving logic out of the Makefile, some optimizations
were done like removing "third-party" from the list of
subdirectories to be searched for documentation and changing some
assignments from "=" to ":=" so they're only evaluated once.
The speed increase is noticeable.
The makeopts.in file was updated to include the paths to
REALPATH and DIRNAME. The ./conifgure script was setting them
but makeopts.in wasn't including them.
So...
With this change, you can now place documentation in any"c"
source file AND you can now place it in a separate XML file
altogether. The following are examples of valid locations:
res/res_pjsip.c
Using the existing /*** DOCUMENTATION ***/ fragment.
res/res_pjsip/pjsip_configuration.c
Using the existing /*** DOCUMENTATION ***/ fragment.
res/res_pjsip/pjsip_doc.xml
A fully-formed XML file. The "configInfo", "manager",
"managerEvent", etc. elements that would be in the "c"
file DOCUMENTATION fragment should be wrapped in proper
XML. Example for "somemodule.xml":
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE docs SYSTEM "appdocsxml.dtd">
<docs>
<configInfo>
...
</configInfo>
</docs>
It's the "appdocsxml.dtd" that tells make_xml_documentation
that this is a documentation XML file and not some other XML file.
It also allows many XML-capable editors to do formatting and
validation.
Other than the ".xml" suffix, the name of the file is not
significant.
As a start... This change also moves the documentation that was
in res_pjsip.c to 2 new XML files in res/res_pjsip:
pjsip_config.xml and pjsip_manager.xml. This cut the number of
lines in res_pjsip.c in half. :)
Change-Id: I486c16c0b5a44d7a8870008e10c941fb19b71ade
This commit is contained in:
George Joseph
Friendly Automation
parent
47106a09b0
commit
a81e14d2da
58
Makefile
58
Makefile
|
|
@ -475,60 +475,24 @@ endif
|
|||
$(INSTALL) -m 644 $$x "$(DESTDIR)$(ASTDATADIR)/rest-api" ; \
|
||||
done
|
||||
|
||||
ifeq ($(GREP),)
|
||||
else ifeq ($(GREP),:)
|
||||
else
|
||||
XML_core_en_US = $(foreach dir,$(MOD_SUBDIRS),$(shell $(GREP) -l "language=\"en_US\"" $(dir)/*.c $(dir)/*.cc 2>/dev/null))
|
||||
endif
|
||||
|
||||
DOC_MOD_SUBDIRS := $(filter-out third-party,$(MOD_SUBDIRS))
|
||||
XML_core_en_US := $(shell build_tools/make_xml_documentation --command=print_dependencies --source-tree=. --mod-subdirs="$(DOC_MOD_SUBDIRS)")
|
||||
# core-en_US.xml is the normal documentation created with asterisk builds.
|
||||
doc/core-en_US.xml: makeopts .lastclean $(XML_core_en_US)
|
||||
@printf "Building Documentation For: "
|
||||
@echo "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" > $@
|
||||
@echo "<!DOCTYPE docs SYSTEM \"appdocsxml.dtd\">" >> $@
|
||||
@echo "<?xml-stylesheet type=\"text/xsl\" href=\"appdocsxml.xslt\"?>" >> $@
|
||||
@echo "<docs xmlns:xi=\"http://www.w3.org/2001/XInclude\">" >> $@
|
||||
@for x in $(MOD_SUBDIRS); do \
|
||||
printf "$$x " ; \
|
||||
for i in `find $$x -name '*.c'`; do \
|
||||
MODULEINFO=$$($(AWK) -f build_tools/get_moduleinfo $$i) ; \
|
||||
if [ -n "$$MODULEINFO" ] ; \
|
||||
then \
|
||||
echo "<module language=\"en_US\" name=\"`$(BASENAME) $$i .c`\">" >> $@ ; \
|
||||
echo "$$MODULEINFO" >> $@ ; \
|
||||
echo "</module>" >> $@ ; \
|
||||
fi ; \
|
||||
$(AWK) -f build_tools/get_documentation $$i >> $@ ; \
|
||||
done ; \
|
||||
done
|
||||
@echo
|
||||
@echo "</docs>" >> $@
|
||||
@build_tools/make_xml_documentation --command=create_xml --source-tree=. --mod-subdirs="$(DOC_MOD_SUBDIRS)" \
|
||||
--with-moduleinfo --validate --output-file=$@
|
||||
|
||||
ifeq ($(GREP),)
|
||||
else ifeq ($(GREP),:)
|
||||
else
|
||||
XML_full_en_US = $(foreach dir,$(MOD_SUBDIRS),$(shell $(GREP) -l "language=\"en_US\"" $(dir)/*.c $(dir)/*.cc 2>/dev/null))
|
||||
endif
|
||||
|
||||
doc/full-en_US.xml: makeopts .lastclean $(XML_full_en_US)
|
||||
# The full-en_US.xml target is only called by the wiki documentation generation process
|
||||
# and does special post-processing in preparation for uploading to the wiki.
|
||||
# It creates full-en_US.xml but then re-creates core-en_US.xml as well.
|
||||
doc/full-en_US.xml: makeopts .lastclean $(XML_core_en_US)
|
||||
ifeq ($(PYTHON),:)
|
||||
@echo "--------------------------------------------------------------------------"
|
||||
@echo "--- Please install python to build full documentation ---"
|
||||
@echo "--------------------------------------------------------------------------"
|
||||
else
|
||||
@printf "Building Documentation For: "
|
||||
@echo "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" > $@
|
||||
@echo "<!DOCTYPE docs SYSTEM \"appdocsxml.dtd\">" >> $@
|
||||
@echo "<?xml-stylesheet type=\"text/xsl\" href=\"appdocsxml.xslt\"?>" >> $@
|
||||
@echo "<docs xmlns:xi=\"http://www.w3.org/2001/XInclude\">" >> $@
|
||||
@for x in $(filter-out third-party,$(MOD_SUBDIRS)); do \
|
||||
printf "$$x " ; \
|
||||
for i in `find $$x -name '*.c'`; do \
|
||||
$(PYTHON) build_tools/get_documentation.py < $$i >> $@ ; \
|
||||
done ; \
|
||||
done
|
||||
@echo
|
||||
@echo "</docs>" >> $@
|
||||
@$(PYTHON) build_tools/post_process_documentation.py -i $@ -o "doc/core-en_US.xml"
|
||||
@build_tools/make_xml_documentation --command=create_xml --source-tree=. --mod-subdirs="$(DOC_MOD_SUBDIRS)" \
|
||||
--for-wiki --validate --output-file=$@ --core-output-file=./doc/core-en_US.xml
|
||||
endif
|
||||
|
||||
validate-docs: doc/core-en_US.xml
|
||||
|
|
|
|||
|
|
@ -0,0 +1,54 @@
|
|||
#!/bin/sh
|
||||
PROGNAME="${0##*/}"
|
||||
|
||||
if [ "$1" = "-h" ] || [ "$1" = "--help" ] ; then
|
||||
cat <<-EOF
|
||||
Usage: ${PROGNAME}: [ <input_file> ] [ <output_file> ]
|
||||
|
||||
This script takes an Asterisk makeopts file, or any file containing
|
||||
"make" style variable assignments, and converts it into a format
|
||||
that can be directly 'sourced' by shell scripts.
|
||||
|
||||
* Any spaces around the equals sign are removed.
|
||||
* The variable value is quoted.
|
||||
* The "make" "or" command is evaluated.
|
||||
|
||||
Both input and output files are optional and will default to
|
||||
stdin and stdout respectively.
|
||||
|
||||
NOTE: This script relies on NO external commands and only POSIX
|
||||
constructs. It should be runnable by any shell.
|
||||
EOF
|
||||
exit 1
|
||||
fi
|
||||
|
||||
input_file="/dev/stdin"
|
||||
if [ "$1" != "" ] ; then
|
||||
input_file="$1"
|
||||
fi
|
||||
|
||||
output_file="/dev/stdout"
|
||||
if [ "$2" != "" ] ; then
|
||||
output_file="$2"
|
||||
fi
|
||||
|
||||
# orfunc is a code fragment to be added to the outp[ut file.
|
||||
# We don't WANT the variables evaluated.
|
||||
# shellcheck disable=SC2016
|
||||
orfunc='or (){ before="${1%,*}" ; after="${1#*,}" ; if [ "$before" = "" ] ; then echo "${after}" ; else echo "${before}" ; fi ; }'
|
||||
echo "${orfunc}" >"${output_file}"
|
||||
|
||||
while read -r LINE ; do
|
||||
var="${LINE%%=*}"
|
||||
if [ "${var}" != "" ] ; then
|
||||
val="${LINE#*=}"
|
||||
if [ "${val}" != "${var}" ] ; then
|
||||
if [ "${val%% *}" = "" ] ; then
|
||||
echo "${var% *}=\"${val#* }\""
|
||||
else
|
||||
echo "${var% *}=\"${val}\""
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
done <"${input_file}" >>"${output_file}"
|
||||
|
||||
|
|
@ -0,0 +1,247 @@
|
|||
#!/bin/sh
|
||||
# The GREP, SED, FIND, etc variables are all set at run time from
|
||||
# makeopts.
|
||||
# shellcheck disable=SC2154
|
||||
|
||||
PROGNAME="${0##*/}"
|
||||
PROGDIR="${0%/*}"
|
||||
|
||||
# Fail on errors
|
||||
set -e
|
||||
|
||||
usage() {
|
||||
cat <<-EOF
|
||||
Usage: ${PROGNAME} --command=(create_xml | print_dependencies)
|
||||
--source-tree=<asterisk_source_tree> [ --mod-subdirs=<subdir_search_list> ]
|
||||
[ --with-moduleinfo ] [--for-wiki ] [ --validate ]
|
||||
[ --output-file=<output_xml_file> ]
|
||||
[ --core-output-file=<core_output_xml_file> ]
|
||||
|
||||
command:
|
||||
print_dependencies: Print the source files that have documentation
|
||||
for use by "make" as dependencies.
|
||||
create_xml: Create the actual XML output file.
|
||||
|
||||
source-tree: The path to the Asterisk source tree.
|
||||
|
||||
mod-subdirs: A quoted, space-separated list of module sub-directories
|
||||
to search for documentation. Defaults to
|
||||
"channels pbx apps codecs formats cdr cel bridges funcs tests main res addons"
|
||||
|
||||
with-moduleinfo: Include the "MODULEINFO" block from source files.
|
||||
Default is to not include MODULEINFO
|
||||
|
||||
for-wiki: Perform special post processing for wiki documentation.
|
||||
This creates two output files and therefore needs both
|
||||
<output-file> and <core-output-file>.
|
||||
Default is to not perform wiki post-processing.
|
||||
|
||||
validate: Run xmllint or xmlstarlet to validate output-file.
|
||||
|
||||
output-file: The XML file to write to if the command was
|
||||
"create_xml".
|
||||
|
||||
core-output-file: The additional XML file to write to if the command was
|
||||
"create_xml" with "for-wiki".
|
||||
|
||||
EOF
|
||||
}
|
||||
|
||||
with_moduleinfo=0
|
||||
for_wiki=0
|
||||
validate=0
|
||||
command=""
|
||||
mod_subdirs="channels pbx apps codecs formats cdr cel bridges funcs tests main res addons"
|
||||
source_tree=""
|
||||
output_file=""
|
||||
core_output_file=""
|
||||
|
||||
for arg in "$@" ; do
|
||||
case ${arg} in
|
||||
--for-wiki)
|
||||
for_wiki=1
|
||||
;;
|
||||
--with-moduleinfo)
|
||||
with_moduleinfo=1
|
||||
;;
|
||||
--validate)
|
||||
validate=1
|
||||
;;
|
||||
--command=*)
|
||||
command=${arg#*=}
|
||||
;;
|
||||
--source-tree=*)
|
||||
source_tree=${arg#*=}
|
||||
;;
|
||||
--mod-subdirs=*)
|
||||
mod_subdirs="${arg#*=}"
|
||||
;;
|
||||
--output-file=*)
|
||||
output_file=${arg#*=}
|
||||
;;
|
||||
--core-output-file=*)
|
||||
core_output_file=${arg#*=}
|
||||
;;
|
||||
-h|--help)
|
||||
usage
|
||||
exit 0
|
||||
;;
|
||||
*)
|
||||
echo "unknown option '${arg}'."
|
||||
usage
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
if [ "${command}" = "" ] ; then
|
||||
echo "No command specified"
|
||||
usage
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ "${source_tree}" = "" ] ; then
|
||||
echo "No source-tree specified"
|
||||
usage
|
||||
exit 1;
|
||||
fi
|
||||
|
||||
if [ ! -d "${source_tree}" ] ; then
|
||||
echo "Asterisk source tree '${source_tree}' doesn't exist."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ ! -f "${source_tree}/Makefile" ] ; then
|
||||
echo "There's no 'Makefile' in '${source_tree}'."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ ! -f "${source_tree}/makeopts" ] ; then
|
||||
echo "There's no 'makeopts' in '${source_tree}'. Maybe you need to run ./configure?"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# This will get the paths to the utilities we need, all
|
||||
# of which will be in makeopts. We need to convert the
|
||||
# format so it's sourceable.
|
||||
tmpname="/tmp/ast_makeopts.$$.env"
|
||||
trap 'rm "$tmpname" >/dev/null 2>&1' INT QUIT TERM EXIT
|
||||
"${PROGDIR}/get_sourceable_makeopts" "${source_tree}/makeopts" >"${tmpname}"
|
||||
# The file to be sourced is generated at run time and can't be checked.
|
||||
# shellcheck disable=SC1090
|
||||
. "${tmpname}"
|
||||
rm "${tmpname}" > /dev/null 2>&1 || :
|
||||
trap - INT QUIT TERM EXIT
|
||||
|
||||
# Make sure we have everything we need.
|
||||
for c in GREP FIND AWK DIRNAME BASENAME SED CAT ; do
|
||||
bin=$(eval "echo \${${c}}")
|
||||
if [ "${bin}" = "" ] ; then
|
||||
echo "The '${c}' utility was not found."
|
||||
exit 1
|
||||
fi
|
||||
done
|
||||
|
||||
if [ "${for_wiki}" -eq "1" ] || [ "${validate}" -eq "1" ]; then
|
||||
if [ "${XMLLINT}${XMLSTARLET}" = "::" ] ; then
|
||||
echo "Either xmllint or xmlstarlet is required for wiki post-processing or validation."
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
if [ "${command}" = "print_dependencies" ] ; then
|
||||
for subdir in ${mod_subdirs} ; do
|
||||
subpath="${source_tree}/${subdir}"
|
||||
# We WANT word splitting in the following line.
|
||||
# shellcheck disable=SC2046
|
||||
${GREP} -l -E '(language="en_US"|appdocsxml.dtd)' $(${FIND} "${subpath}" -name '*.c' -or -name '*.cc' -or -name '*.xml') || :
|
||||
done
|
||||
exit
|
||||
fi
|
||||
|
||||
if [ "${command}" != "create_xml" ] ; then
|
||||
echo "Command '${command}' is invalid."
|
||||
usage
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ "${output_file}" = "" ] ; then
|
||||
echo "output-file is required for command '${command}'."
|
||||
usage
|
||||
exit 1;
|
||||
fi
|
||||
|
||||
output_dir=$(${DIRNAME} "${output_file}")
|
||||
if [ ! -d "${output_dir}" ] ; then
|
||||
echo "output destination directory '${output_dir}' doesn't exist."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ "${for_wiki}" -eq "1" ] && [ "${core_output_file}" = "" ] ; then
|
||||
echo "core-output-file is required for command '${command}' and 'for-wiki'."
|
||||
usage
|
||||
exit 1;
|
||||
fi
|
||||
|
||||
core_output_dir=$(${DIRNAME} "${core_output_file}")
|
||||
if [ ! -d "${core_output_dir}" ] ; then
|
||||
echo "core destination directory '${core_output_dir}' doesn't exist."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
${CAT} > "${output_file}" <<-EOF
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE docs SYSTEM "appdocsxml.dtd">
|
||||
<?xml-stylesheet type="text/xsl" href="appdocsxml.xslt"?>
|
||||
<docs xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
EOF
|
||||
|
||||
printf "Building Documentation For: "
|
||||
|
||||
for subdir in ${mod_subdirs} ; do
|
||||
printf "%s " "${subdir}"
|
||||
subdir_path="${source_tree}/${subdir}"
|
||||
for i in $(${FIND} "${subdir_path}" -name '*.c' -or -name '*.cc'); do
|
||||
if [ "${with_moduleinfo}" -eq "1" ] ; then
|
||||
MODULEINFO=$(${AWK} -f "${source_tree}/build_tools/get_moduleinfo" "${i}")
|
||||
if [ "${MODULEINFO}" != "" ] ; then
|
||||
${CAT} >> "${output_file}" <<-EOF
|
||||
<module language="en_US" name="$(${BASENAME} "${i}" .c)">
|
||||
${MODULEINFO}
|
||||
</module>
|
||||
EOF
|
||||
fi
|
||||
fi
|
||||
if [ "${for_wiki}" -eq "1" ] ; then
|
||||
${PYTHON} build_tools/get_documentation.py < "${i}" >> "${output_file}"
|
||||
else
|
||||
${AWK} -f "${source_tree}/build_tools/get_documentation" "${i}" >> "${output_file}"
|
||||
fi
|
||||
done
|
||||
for i in $(${FIND} "${subdir_path}" -name '*.xml') ; do
|
||||
${GREP} -q "appdocsxml.dtd" "${i}" || continue
|
||||
if [ "${validate}" -eq "1" ] ;then
|
||||
if [ "${XMLLINT}" != ":" ] ; then
|
||||
${XMLLINT} --dtdvalid "${source_tree}/doc/appdocsxml.dtd" --path "${source_tree}/doc" --noout "${i}" || { echo "" ; exit 1 ; }
|
||||
else
|
||||
${XMLSTARLET} val -d "${source_tree}/doc/appdocsxml.dtd" "${i}" || { echo "" ; exit 1 ; }
|
||||
fi
|
||||
fi
|
||||
${SED} -r "/^\s*(<[?]xml|<.DOCTYPE|<.?docs)/d" "${i}" >> "${output_file}"
|
||||
done
|
||||
done
|
||||
echo "</docs>" >> "${output_file}"
|
||||
echo ""
|
||||
|
||||
if [ "${for_wiki}" -eq "1" ] ; then
|
||||
${PYTHON} build_tools/post_process_documentation.py -i "${output_file}" -o "${core_output_file}"
|
||||
fi
|
||||
|
||||
if [ "${validate}" -eq "1" ] ;then
|
||||
if [ "${XMLLINT}" != ":" ] ; then
|
||||
${XMLLINT} --dtdvalid "${source_tree}/doc/appdocsxml.dtd" --path "${source_tree}/doc" --noout "${output_file}" || exit 1
|
||||
else
|
||||
${XMLSTARLET} val -d "${source_tree}/doc/appdocsxml.dtd" "${output_file}" || exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
|
|
@ -46,6 +46,8 @@ SED=@SED@
|
|||
NM=@NM@
|
||||
CAT=@CAT@
|
||||
CUT=@CUT@
|
||||
REALPATH=@REALPATH@
|
||||
DIRNAME=@DIRNAME@
|
||||
|
||||
BUILD_PLATFORM=@BUILD_PLATFORM@
|
||||
BUILD_CPU=@BUILD_CPU@
|
||||
|
|
|
|||
3242
res/res_pjsip.c
3242
res/res_pjsip.c
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,900 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE docs SYSTEM "appdocsxml.dtd">
|
||||
<docs>
|
||||
<manager name="PJSIPQualify" language="en_US">
|
||||
<synopsis>
|
||||
Qualify a chan_pjsip endpoint.
|
||||
</synopsis>
|
||||
<syntax>
|
||||
<xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
|
||||
<parameter name="Endpoint" required="true">
|
||||
<para>The endpoint you want to qualify.</para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
<description>
|
||||
<para>Qualify a chan_pjsip endpoint.</para>
|
||||
</description>
|
||||
</manager>
|
||||
<managerEvent language="en_US" name="IdentifyDetail">
|
||||
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
||||
<synopsis>Provide details about an identify section.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="ObjectType">
|
||||
<para>The object's type. This will always be 'identify'.</para>
|
||||
</parameter>
|
||||
<parameter name="ObjectName">
|
||||
<para>The name of this object.</para>
|
||||
</parameter>
|
||||
<parameter name="Endpoint">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip_endpoint_identifier_ip']/configFile[@name='pjsip.conf']/configObject[@name='identify']/configOption[@name='endpoint']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="SrvLookups">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip_endpoint_identifier_ip']/configFile[@name='pjsip.conf']/configObject[@name='identify']/configOption[@name='srv_lookups']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Match">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip_endpoint_identifier_ip']/configFile[@name='pjsip.conf']/configObject[@name='identify']/configOption[@name='match']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="MatchHeader">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip_endpoint_identifier_ip']/configFile[@name='pjsip.conf']/configObject[@name='identify']/configOption[@name='match_header']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="EndpointName">
|
||||
<para>The name of the endpoint associated with this information.</para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
<managerEvent language="en_US" name="AorDetail">
|
||||
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
||||
<synopsis>Provide details about an Address of Record (AoR) section.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="ObjectType">
|
||||
<para>The object's type. This will always be 'aor'.</para>
|
||||
</parameter>
|
||||
<parameter name="ObjectName">
|
||||
<para>The name of this object.</para>
|
||||
</parameter>
|
||||
<parameter name="MinimumExpiration">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='minimum_expiration']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="MaximumExpiration">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='maximum_expiration']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="DefaultExpiration">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='default_expiration']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="QualifyFrequency">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='qualify_frequency']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="AuthenticateQualify">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='authenticate_qualify']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="MaxContacts">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='max_contacts']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="RemoveExisting">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='remove_existing']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="RemoveUnavailable">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='remove_unavailable']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Mailboxes">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='mailboxes']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="OutboundProxy">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='outbound_proxy']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="SupportPath">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='support_path']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="TotalContacts">
|
||||
<para>The total number of contacts associated with this AoR.</para>
|
||||
</parameter>
|
||||
<parameter name="ContactsRegistered">
|
||||
<para>The number of non-permanent contacts associated with this AoR.</para>
|
||||
</parameter>
|
||||
<parameter name="EndpointName">
|
||||
<para>The name of the endpoint associated with this information.</para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
<managerEvent language="en_US" name="AuthDetail">
|
||||
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
||||
<synopsis>Provide details about an authentication section.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="ObjectType">
|
||||
<para>The object's type. This will always be 'auth'.</para>
|
||||
</parameter>
|
||||
<parameter name="ObjectName">
|
||||
<para>The name of this object.</para>
|
||||
</parameter>
|
||||
<parameter name="Username">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='username']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Password">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='username']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Md5Cred">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='md5_cred']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Realm">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='realm']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="NonceLifetime">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='nonce_lifetime']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="AuthType">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='auth_type']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="EndpointName">
|
||||
<para>The name of the endpoint associated with this information.</para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
<managerEvent language="en_US" name="TransportDetail">
|
||||
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
||||
<synopsis>Provide details about an authentication section.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="ObjectType">
|
||||
<para>The object's type. This will always be 'transport'.</para>
|
||||
</parameter>
|
||||
<parameter name="ObjectName">
|
||||
<para>The name of this object.</para>
|
||||
</parameter>
|
||||
<parameter name="Protocol">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='protocol']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Bind">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='bind']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="AsycOperations">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='async_operations']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="CaListFile">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='ca_list_file']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="CaListPath">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='ca_list_path']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="CertFile">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='cert_file']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="PrivKeyFile">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='priv_key_file']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Password">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='password']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="ExternalSignalingAddress">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='external_signaling_address']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="ExternalSignalingPort">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='external_signaling_port']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="ExternalMediaAddress">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='external_media_address']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Domain">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='domain']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="VerifyServer">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='verify_server']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="VerifyClient">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='verify_client']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="RequireClientCert">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='require_client_cert']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Method">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='method']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Cipher">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='cipher']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="LocalNet">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='local_net']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Tos">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='tos']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Cos">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='cos']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="WebsocketWriteTimeout">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='transport']/configOption[@name='websocket_write_timeout']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="EndpointName">
|
||||
<para>The name of the endpoint associated with this information.</para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
<managerEvent language="en_US" name="EndpointDetail">
|
||||
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
||||
<synopsis>Provide details about an endpoint section.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="ObjectType">
|
||||
<para>The object's type. This will always be 'endpoint'.</para>
|
||||
</parameter>
|
||||
<parameter name="ObjectName">
|
||||
<para>The name of this object.</para>
|
||||
</parameter>
|
||||
<parameter name="Context">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='context']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Disallow">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='disallow']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Allow">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='allow']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="DtmfMode">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtmf_mode']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="RtpIpv6">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='rtp_ipv6']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="RtpSymmetric">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='rtp_symmetric']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="IceSupport">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='ice_support']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="UsePtime">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='use_ptime']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="ForceRport">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='force_rport']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="RewriteContact">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='rewrite_contact']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Transport">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='transport']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="OutboundProxy">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='outbound_proxy']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="MohSuggest">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='moh_suggest']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="100rel">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='100rel']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Timers">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='timers']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="TimersMinSe">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='timers_min_se']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="TimersSessExpires">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='timers_sess_expires']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Auth">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='auth']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="OutboundAuth">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='outbound_auth']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Aors">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='aors']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="MediaAddress">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='media_address']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="IdentifyBy">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='identify_by']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="DirectMedia">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='direct_media']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="DirectMediaMethod">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='direct_media_method']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="TrustConnectedLine">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='trust_connected_line']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="SendConnectedLine">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='send_connected_line']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="ConnectedLineMethod">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='connected_line_method']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="DirectMediaGlareMitigation">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='direct_media_glare_mitigation']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="DisableDirectMediaOnNat">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='disable_direct_media_on_nat']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Callerid">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='callerid']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="CalleridPrivacy">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='callerid_privacy']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="CalleridTag">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='callerid_tag']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="TrustIdInbound">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='trust_id_inbound']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="TrustIdOutbound">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='trust_id_outbound']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="SendPai">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='send_pai']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="SendRpid">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='send_rpid']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="SendDiversion">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='send_diversion']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Mailboxes">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='mailboxes']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="AggregateMwi">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='aggregate_mwi']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="MediaEncryption">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='media_encryption']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="MediaEncryptionOptimistic">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='media_encryption_optimistic']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="UseAvpf">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='use_avpf']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="ForceAvp">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='force_avp']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="MediaUseReceivedTransport">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='media_use_received_transport']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="OneTouchRecording">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='one_touch_recording']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="InbandProgress">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='inband_progress']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="CallGroup">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='call_group']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="PickupGroup">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='pickup_group']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="NamedCallGroup">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='named_call_group']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="NamedPickupGroup">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='named_pickup_group']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="DeviceStateBusyAt">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='device_state_busy_at']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="T38Udptl">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='t38_udptl']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="T38UdptlEc">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='t38_udptl_ec']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="T38UdptlMaxdatagram">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='t38_udptl_maxdatagram']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="FaxDetect">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='fax_detect']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="T38UdptlNat">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='t38_udptl_nat']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="T38UdptlIpv6">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='t38_udptl_ipv6']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="T38BindUdptlToMediaAddress">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='t38_bind_udptl_to_media_address']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="ToneZone">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='tone_zone']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Language">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='language']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="RecordOnFeature">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='record_on_feature']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="RecordOffFeature">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='record_off_feature']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="AllowTransfer">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='allow_transfer']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="UserEqPhone">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='user_eq_phone']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="MohPassthrough">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='moh_passthrough']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="SdpOwner">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='sdp_owner']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="SdpSession">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='sdp_session']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="TosAudio">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='tos_audio']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="TosVideo">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='tos_video']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="CosAudio">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='cos_audio']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="CosVideo">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='cos_video']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="AllowSubscribe">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='allow_subscribe']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="SubMinExpiry">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='sub_min_expiry']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="FromUser">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='from_user']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="FromDomain">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='from_domain']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="MwiFromUser">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='mwi_from_user']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="RtpEngine">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='rtp_engine']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="DtlsVerify">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtls_verify']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="DtlsRekey">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtls_rekey']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="DtlsCertFile">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtls_cert_file']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="DtlsPrivateKey">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtls_private_key']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="DtlsCipher">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtls_cipher']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="DtlsCaFile">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtls_ca_file']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="DtlsCaPath">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtls_ca_path']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="DtlsSetup">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='dtls_setup']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="SrtpTag32">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='srtp_tag_32']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="RedirectMethod">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='redirect_method']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="SetVar">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='set_var']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="MessageContext">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='message_context']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Accountcode">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='accountcode']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="PreferredCodecOnly">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='preferred_codec_only']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="DeviceState">
|
||||
<para>The aggregate device state for this endpoint.</para>
|
||||
</parameter>
|
||||
<parameter name="ActiveChannels">
|
||||
<para>The number of active channels associated with this endpoint.</para>
|
||||
</parameter>
|
||||
<parameter name="SubscribeContext">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='subscribe_context']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Allowoverlap">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='endpoint']/configOption[@name='allow_overlap']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
<managerEvent language="en_US" name="AorList">
|
||||
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
||||
<synopsis>Provide details about an Address of Record (AoR) section.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="ObjectType">
|
||||
<para>The object's type. This will always be 'aor'.</para>
|
||||
</parameter>
|
||||
<parameter name="ObjectName">
|
||||
<para>The name of this object.</para>
|
||||
</parameter>
|
||||
<parameter name="MinimumExpiration">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='minimum_expiration']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="MaximumExpiration">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='maximum_expiration']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="DefaultExpiration">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='default_expiration']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="QualifyFrequency">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='qualify_frequency']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="AuthenticateQualify">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='authenticate_qualify']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="MaxContacts">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='max_contacts']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="RemoveExisting">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='remove_existing']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="RemoveUnavailable">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='remove_unavailable']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Mailboxes">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='mailboxes']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="OutboundProxy">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='outbound_proxy']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="SupportPath">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='aor']/configOption[@name='support_path']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
<managerEvent language="en_US" name="AuthList">
|
||||
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
||||
<synopsis>Provide details about an Address of Record (Auth) section.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="ObjectType">
|
||||
<para>The object's type. This will always be 'auth'.</para>
|
||||
</parameter>
|
||||
<parameter name="ObjectName">
|
||||
<para>The name of this object.</para>
|
||||
</parameter>
|
||||
<parameter name="Username">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='username']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Md5Cred">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='md5_cred']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Realm">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='realm']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="AuthType">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='auth_type']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="Password">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='password']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
<parameter name="NonceLifetime">
|
||||
<para><xi:include xpointer="xpointer(/docs/configInfo[@name='res_pjsip']/configFile[@name='pjsip.conf']/configObject[@name='auth']/configOption[@name='nonce_lifetime']/synopsis/node())"/></para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
<managerEvent language="en_US" name="ContactList">
|
||||
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
||||
<synopsis>Provide details about a contact section.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="ObjectType">
|
||||
<para>The object's type. This will always be 'contact'.</para>
|
||||
</parameter>
|
||||
<parameter name="ObjectName">
|
||||
<para>The name of this object.</para>
|
||||
</parameter>
|
||||
<parameter name="ViaAddr">
|
||||
<para>IP address of the last Via header in REGISTER request.
|
||||
Will only appear in the event if available.</para>
|
||||
</parameter>
|
||||
<parameter name="ViaPort">
|
||||
<para>Port number of the last Via header in REGISTER request.
|
||||
Will only appear in the event if available.</para>
|
||||
</parameter>
|
||||
<parameter name="QualifyTimeout">
|
||||
<para>The elapsed time in decimal seconds after which an OPTIONS
|
||||
message is sent before the contact is considered unavailable.</para>
|
||||
</parameter>
|
||||
<parameter name="CallId">
|
||||
<para>Content of the Call-ID header in REGISTER request.
|
||||
Will only appear in the event if available.</para>
|
||||
</parameter>
|
||||
<parameter name="RegServer">
|
||||
<para>Asterisk Server name.</para>
|
||||
</parameter>
|
||||
<parameter name="PruneOnBoot">
|
||||
<para>If true delete the contact on Asterisk restart/boot.</para>
|
||||
</parameter>
|
||||
<parameter name="Path">
|
||||
<para>The Path header received on the REGISTER.</para>
|
||||
</parameter>
|
||||
<parameter name="Endpoint">
|
||||
<para>The name of the endpoint associated with this information.</para>
|
||||
</parameter>
|
||||
<parameter name="AuthenticateQualify">
|
||||
<para>A boolean indicating whether a qualify should be authenticated.</para>
|
||||
</parameter>
|
||||
<parameter name="Uri">
|
||||
<para>This contact's URI.</para>
|
||||
</parameter>
|
||||
<parameter name="QualifyFrequency">
|
||||
<para>The interval in seconds at which the contact will be qualified.</para>
|
||||
</parameter>
|
||||
<parameter name="UserAgent">
|
||||
<para>Content of the User-Agent header in REGISTER request</para>
|
||||
</parameter>
|
||||
<parameter name="ExpirationTime">
|
||||
<para>Absolute time that this contact is no longer valid after</para>
|
||||
</parameter>
|
||||
<parameter name="OutboundProxy">
|
||||
<para>The contact's outbound proxy.</para>
|
||||
</parameter>
|
||||
<parameter name="Status">
|
||||
<para>This contact's status.</para>
|
||||
<enumlist>
|
||||
<enum name="Reachable"/>
|
||||
<enum name="Unreachable"/>
|
||||
<enum name="NonQualified"/>
|
||||
<enum name="Unknown"/>
|
||||
</enumlist>
|
||||
</parameter>
|
||||
<parameter name="RoundtripUsec">
|
||||
<para>The round trip time in microseconds.</para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
<managerEvent language="en_US" name="ContactStatusDetail">
|
||||
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
||||
<synopsis>Provide details about a contact's status.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="AOR">
|
||||
<para>The AoR that owns this contact.</para>
|
||||
</parameter>
|
||||
<parameter name="URI">
|
||||
<para>This contact's URI.</para>
|
||||
</parameter>
|
||||
<parameter name="Status">
|
||||
<para>This contact's status.</para>
|
||||
<enumlist>
|
||||
<enum name="Reachable"/>
|
||||
<enum name="Unreachable"/>
|
||||
<enum name="NonQualified"/>
|
||||
<enum name="Unknown"/>
|
||||
</enumlist>
|
||||
</parameter>
|
||||
<parameter name="RoundtripUsec">
|
||||
<para>The round trip time in microseconds.</para>
|
||||
</parameter>
|
||||
<parameter name="EndpointName">
|
||||
<para>The name of the endpoint associated with this information.</para>
|
||||
</parameter>
|
||||
<parameter name="UserAgent">
|
||||
<para>Content of the User-Agent header in REGISTER request</para>
|
||||
</parameter>
|
||||
<parameter name="RegExpire">
|
||||
<para>Absolute time that this contact is no longer valid after</para>
|
||||
</parameter>
|
||||
<parameter name="ViaAddress">
|
||||
<para>IP address:port of the last Via header in REGISTER request.
|
||||
Will only appear in the event if available.</para>
|
||||
</parameter>
|
||||
<parameter name="CallID">
|
||||
<para>Content of the Call-ID header in REGISTER request.
|
||||
Will only appear in the event if available.</para>
|
||||
</parameter>
|
||||
<parameter name="ID">
|
||||
<para>The sorcery ID of the contact.</para>
|
||||
</parameter>
|
||||
<parameter name="AuthenticateQualify">
|
||||
<para>A boolean indicating whether a qualify should be authenticated.</para>
|
||||
</parameter>
|
||||
<parameter name="OutboundProxy">
|
||||
<para>The contact's outbound proxy.</para>
|
||||
</parameter>
|
||||
<parameter name="Path">
|
||||
<para>The Path header received on the REGISTER.</para>
|
||||
</parameter>
|
||||
<parameter name="QualifyFrequency">
|
||||
<para>The interval in seconds at which the contact will be qualified.</para>
|
||||
</parameter>
|
||||
<parameter name="QualifyTimeout">
|
||||
<para>The elapsed time in decimal seconds after which an OPTIONS
|
||||
message is sent before the contact is considered unavailable.</para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
<managerEvent language="en_US" name="EndpointList">
|
||||
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
||||
<synopsis>Provide details about a contact's status.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="ObjectType">
|
||||
<para>The object's type. This will always be 'endpoint'.</para>
|
||||
</parameter>
|
||||
<parameter name="ObjectName">
|
||||
<para>The name of this object.</para>
|
||||
</parameter>
|
||||
<parameter name="Transport">
|
||||
<para>The transport configurations associated with this endpoint.</para>
|
||||
</parameter>
|
||||
<parameter name="Aor">
|
||||
<para>The aor configurations associated with this endpoint.</para>
|
||||
</parameter>
|
||||
<parameter name="Auths">
|
||||
<para>The inbound authentication configurations associated with this endpoint.</para>
|
||||
</parameter>
|
||||
<parameter name="OutboundAuths">
|
||||
<para>The outbound authentication configurations associated with this endpoint.</para>
|
||||
</parameter>
|
||||
<parameter name="DeviceState">
|
||||
<para>The aggregate device state for this endpoint.</para>
|
||||
</parameter>
|
||||
<parameter name="ActiveChannels">
|
||||
<para>The number of active channels associated with this endpoint.</para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
<manager name="PJSIPShowEndpoints" language="en_US">
|
||||
<synopsis>
|
||||
Lists PJSIP endpoints.
|
||||
</synopsis>
|
||||
<syntax />
|
||||
<description>
|
||||
<para>
|
||||
Provides a listing of all endpoints. For each endpoint an <literal>EndpointList</literal> event
|
||||
is raised that contains relevant attributes and status information. Once all
|
||||
endpoints have been listed an <literal>EndpointListComplete</literal> event is issued.
|
||||
</para>
|
||||
</description>
|
||||
<responses>
|
||||
<list-elements>
|
||||
<xi:include xpointer="xpointer(/docs/managerEvent[@name='EndpointList'])" />
|
||||
</list-elements>
|
||||
<managerEvent language="en_US" name="EndpointListComplete">
|
||||
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
||||
<synopsis>Provide final information about an endpoint list.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="EventList"/>
|
||||
<parameter name="ListItems"/>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
</responses>
|
||||
</manager>
|
||||
<manager name="PJSIPShowEndpoint" language="en_US">
|
||||
<synopsis>
|
||||
Detail listing of an endpoint and its objects.
|
||||
</synopsis>
|
||||
<syntax>
|
||||
<xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
|
||||
<parameter name="Endpoint" required="true">
|
||||
<para>The endpoint to list.</para>
|
||||
</parameter>
|
||||
</syntax>
|
||||
<description>
|
||||
<para>
|
||||
Provides a detailed listing of options for a given endpoint. Events are issued
|
||||
showing the configuration and status of the endpoint and associated objects. These
|
||||
events include <literal>EndpointDetail</literal>, <literal>AorDetail</literal>,
|
||||
<literal>AuthDetail</literal>, <literal>TransportDetail</literal>, and
|
||||
<literal>IdentifyDetail</literal>. Some events may be listed multiple times if multiple objects are
|
||||
associated (for instance AoRs). Once all detail events have been raised a final
|
||||
<literal>EndpointDetailComplete</literal> event is issued.
|
||||
</para>
|
||||
</description>
|
||||
<responses>
|
||||
<list-elements>
|
||||
<xi:include xpointer="xpointer(/docs/managerEvent[@name='EndpointDetail'])" />
|
||||
<xi:include xpointer="xpointer(/docs/managerEvent[@name='IdentifyDetail'])" />
|
||||
<xi:include xpointer="xpointer(/docs/managerEvent[@name='ContactStatusDetail'])" />
|
||||
<xi:include xpointer="xpointer(/docs/managerEvent[@name='AuthDetail'])" />
|
||||
<xi:include xpointer="xpointer(/docs/managerEvent[@name='TransportDetail'])" />
|
||||
<xi:include xpointer="xpointer(/docs/managerEvent[@name='AorDetail'])" />
|
||||
</list-elements>
|
||||
<managerEvent language="en_US" name="EndpointDetailComplete">
|
||||
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
||||
<synopsis>Provide final information about endpoint details.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="EventList"/>
|
||||
<parameter name="ListItems"/>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
</responses>
|
||||
</manager>
|
||||
<manager name="PJSIPShowAors" language="en_US">
|
||||
<synopsis>
|
||||
Lists PJSIP AORs.
|
||||
</synopsis>
|
||||
<syntax />
|
||||
<description>
|
||||
<para>
|
||||
Provides a listing of all AORs. For each AOR an <literal>AorList</literal> event
|
||||
is raised that contains relevant attributes and status information. Once all
|
||||
aors have been listed an <literal>AorListComplete</literal> event is issued.
|
||||
</para>
|
||||
</description>
|
||||
<responses>
|
||||
<list-elements>
|
||||
<xi:include xpointer="xpointer(/docs/managerEvent[@name='AorList'])" />
|
||||
</list-elements>
|
||||
<managerEvent language="en_US" name="AorListComplete">
|
||||
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
||||
<synopsis>Provide final information about an aor list.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="EventList"/>
|
||||
<parameter name="ListItems"/>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
</responses>
|
||||
</manager>
|
||||
<manager name="PJSIPShowAuths" language="en_US">
|
||||
<synopsis>
|
||||
Lists PJSIP Auths.
|
||||
</synopsis>
|
||||
<syntax />
|
||||
<description>
|
||||
<para>Provides a listing of all Auths. For each Auth an <literal>AuthList</literal> event
|
||||
is raised that contains relevant attributes and status information. Once all
|
||||
auths have been listed an <literal>AuthListComplete</literal> event is issued.
|
||||
</para>
|
||||
</description>
|
||||
<responses>
|
||||
<list-elements>
|
||||
<xi:include xpointer="xpointer(/docs/managerEvent[@name='AuthList'])" />
|
||||
</list-elements>
|
||||
<managerEvent language="en_US" name="AuthListComplete">
|
||||
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
||||
<synopsis>Provide final information about an auth list.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="EventList"/>
|
||||
<parameter name="ListItems"/>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
</responses>
|
||||
</manager>
|
||||
<manager name="PJSIPShowContacts" language="en_US">
|
||||
<synopsis>
|
||||
Lists PJSIP Contacts.
|
||||
</synopsis>
|
||||
<syntax />
|
||||
<description>
|
||||
<para>Provides a listing of all Contacts. For each Contact a <literal>ContactList</literal>
|
||||
event is raised that contains relevant attributes and status information.
|
||||
Once all contacts have been listed a <literal>ContactListComplete</literal> event
|
||||
is issued.
|
||||
</para>
|
||||
</description>
|
||||
<responses>
|
||||
<list-elements>
|
||||
<xi:include xpointer="xpointer(/docs/managerEvent[@name='ContactList'])" />
|
||||
</list-elements>
|
||||
<managerEvent language="en_US" name="ContactListComplete">
|
||||
<managerEventInstance class="EVENT_FLAG_COMMAND">
|
||||
<synopsis>Provide final information about a contact list.</synopsis>
|
||||
<syntax>
|
||||
<parameter name="EventList"/>
|
||||
<parameter name="ListItems"/>
|
||||
</syntax>
|
||||
</managerEventInstance>
|
||||
</managerEvent>
|
||||
</responses>
|
||||
</manager>
|
||||
</docs>
|
||||
Loading…
Reference in New Issue