[svn-commits] russell: branch group/sip-object-matching r178067 - /team/group/sip-object-ma...

[SVN commits to the Digium repositories]

Author: russell
Date: Mon Feb 23 12:48:16 2009
New Revision: 178067

URL: http://svn.digium.com/svn-view/asterisk?view=rev&rev=178067
Log:
make it clear that which_objects only affects name lookups

Modified:
    team/group/sip-object-matching/channels/chan_sip.c

Modified: team/group/sip-object-matching/channels/chan_sip.c
URL: http://svn.digium.com/svn-view/asterisk/team/group/sip-object-matching/channels/chan_sip.c?view=diff&rev=178067&r1=178066&r2=178067
==============================================================================
--- team/group/sip-object-matching/channels/chan_sip.c (original)
+++ team/group/sip-object-matching/channels/chan_sip.c Mon Feb 23 12:48:16 2009
@@ -4528,14 +4528,19 @@
 	return CMP_MATCH | CMP_STOP;
 }
 
-/*! \brief Locate device by name or ip address 
+/*! 
+ * \brief Locate device by name or ip address 
+ *
+ * \param which_objects Define which objects should be matched when doing a lookup
+ *        by name.  Valid options are FINDUSERS, FINDPEERS, or FINDALLDEVICES.
+ *        Note that this option is not used at all when doing a lookup by IP.
+ *
  *	This is used on find matching device on name or ip/port.
-	If the device was declared as type=peer, we don't match on peer name on incoming INVITEs.
-	
-	\note Avoid using this function in new functions if there is a way to avoid it,
-	since it might cause a database lookup.
-
-*/
+ * If the device was declared as type=peer, we don't match on peer name on incoming INVITEs.
+ *
+ * \note Avoid using this function in new functions if there is a way to avoid it,
+ * since it might cause a database lookup.
+ */
 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime, int which_objects, int devstate_only)
 {
 	struct sip_peer *p = NULL;