diff options
| author | Rusty Newton <rnewton@digium.com> | 2013-09-25 18:38:34 +0000 |
|---|---|---|
| committer | Rusty Newton <rnewton@digium.com> | 2013-09-25 18:38:34 +0000 |
| commit | 1b9db0fd99cf935b41fe03e45f11dbae138b6c6b (patch) | |
| tree | 4ce55ace54d891e9043da9af62bd14673d0187ac /res/res_pjsip.c | |
| parent | 88436ecbd448569b1517d3340c2f8486010ff0ae (diff) | |
Fixing documentation for the configOption "external_media_address" of both Endpoints and Transports
Re-using some of Mark Michelson's text from an E-mail discussion for:
* Modifying synopsis for both options
* Adding description to both options
* Changing name of "external_media_address" for Endpoint configuration to "media_address" in anticipation of the option name being changed. (As it is not really specific to external destinations)
(issue ASTERISK-22405)
(closes issue ASTERISK-22405)
Reported by: Rusty Newton
Review: https://reviewboard.asterisk.org/r/2850/
........
Merged revisions 399781 from http://svn.asterisk.org/svn/asterisk/branches/12
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@399782 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'res/res_pjsip.c')
| -rw-r--r-- | res/res_pjsip.c | 20 |
1 files changed, 17 insertions, 3 deletions
diff --git a/res/res_pjsip.c b/res/res_pjsip.c index 3297bd924..f18375395 100644 --- a/res/res_pjsip.c +++ b/res/res_pjsip.c @@ -208,8 +208,15 @@ </enumlist> </description> </configOption> - <configOption name="external_media_address"> - <synopsis>IP used for External Media handling</synopsis> + <configOption name="media_address"> + <synopsis>IP address used in SDP for media handling</synopsis> + <description><para> + At the time of SDP creation, the IP address defined here will be used as + the media address for individual streams in the SDP. + </para><note> + Be aware that the <literal>external_media_address</literal> option, set in Transport + configuration, can also affect the final media address used in the SDP. + </note></description> </configOption> <configOption name="force_rport" default="yes"> <synopsis>Force use of return port</synopsis> @@ -730,7 +737,14 @@ <synopsis>Domain the transport comes from</synopsis> </configOption> <configOption name="external_media_address"> - <synopsis>External Address to use in RTP handling</synopsis> + <synopsis>External IP address to use in RTP handling</synopsis> + <description><para> + When a request or response is sent out, if the destination of the + message is outside the IP network defined in the option <literal>localnet</literal>, + and the media address in the SDP is within the localnet network, then the + media address in the SDP will be rewritten to the value defined for + <literal>external_media_address</literal>. + </para></description> </configOption> <configOption name="external_signaling_address"> <synopsis>External address for SIP signalling</synopsis> |