diff options
| author | Richard Mudgett <rmudgett@digium.com> | 2018-01-03 17:26:42 -0600 |
|---|---|---|
| committer | Richard Mudgett <rmudgett@digium.com> | 2018-01-09 13:38:59 -0600 |
| commit | 8f3167c5f17a5c85bd7d6c42f3c22f56e081eaba (patch) | |
| tree | 075d024e72a306d865887f0fee7d233458883cf8 /res/res_pjsip_endpoint_identifier_ip.c | |
| parent | 3a7d91725607b84274c068550096307f59e6b9f8 (diff) | |
res_pjsip.c: Update the endpoint identification documentation.
* Endpoint identify_by documentation.
* IP/Header endpoint identifier documentation.
Change-Id: Id92f00b495acca7be945daf749d2abd7f76a0b5a
Diffstat (limited to 'res/res_pjsip_endpoint_identifier_ip.c')
| -rw-r--r-- | res/res_pjsip_endpoint_identifier_ip.c | 45 |
1 files changed, 27 insertions, 18 deletions
diff --git a/res/res_pjsip_endpoint_identifier_ip.c b/res/res_pjsip_endpoint_identifier_ip.c index e40f9bff4..add1146f7 100644 --- a/res/res_pjsip_endpoint_identifier_ip.c +++ b/res/res_pjsip_endpoint_identifier_ip.c @@ -43,41 +43,50 @@ <para>This module provides alternatives to matching inbound requests to a configured endpoint. At least one of the matching mechanisms must be provided, or the object configuration will be invalid.</para> - <para>If multiple criteria are provided, an inbound request will - be matched if it matches <emphasis>any</emphasis> of the criteria.</para> <para>The matching mechanisms are provided by the following configuration options:</para> <enumlist> <enum name="match"><para>Match by source IP address.</para></enum> <enum name="match_header"><para>Match by SIP header.</para></enum> </enumlist> + <note><para>If multiple matching criteria are provided then an inbound + request will be matched to the endpoint if it matches + <emphasis>any</emphasis> of the criteria.</para></note> </description> <configOption name="endpoint"> - <synopsis>Name of Endpoint</synopsis> + <synopsis>Name of endpoint identified</synopsis> </configOption> <configOption name="match"> <synopsis>IP addresses or networks to match against.</synopsis> - <description><para> - The value is a comma-delimited list of IP addresses. IP addresses may - have a subnet mask appended. The subnet mask may be written in either - CIDR or dot-decimal notation. Separate the IP address and subnet - mask with a slash ('/'). - </para></description> + <description> + <para>The value is a comma-delimited list of IP addresses or + hostnames. IP addresses may have a subnet mask appended. The + subnet mask may be written in either CIDR or dotted-decimal + notation. Separate the IP address and subnet mask with a slash + ('/'). + </para> + </description> </configOption> <configOption name="srv_lookups" default="yes"> <synopsis>Perform SRV lookups for provided hostnames.</synopsis> - <description><para>When enabled, <replaceable>srv_lookups</replaceable> will - perform SRV lookups for _sip._udp, _sip._tcp, and _sips._tcp of the given - hostnames to determine additional addresses that traffic may originate from. - </para></description> + <description> + <para>When enabled, <replaceable>srv_lookups</replaceable> will + perform SRV lookups for _sip._udp, _sip._tcp, and _sips._tcp of + the given hostnames to determine additional addresses that traffic + may originate from. + </para> + </description> </configOption> <configOption name="match_header"> <synopsis>Header/value pair to match against.</synopsis> - <description><para>A SIP header who value is used to match against. SIP - requests containing the header, along with the specified value, will be - mapped to the specified endpoint. The header must be specified with a - <literal>:</literal>, as in <literal>match_header = SIPHeader: value</literal>. - </para></description> + <description> + <para>A SIP header whose value is used to match against. SIP + requests containing the header, along with the specified value, + will be mapped to the specified endpoint. The header must be + specified with a <literal>:</literal>, as in + <literal>match_header = SIPHeader: value</literal>. + </para> + </description> </configOption> <configOption name="type"> <synopsis>Must be of type 'identify'.</synopsis> |