- Add doxygen documentation for sipsock_read locking

- Improve documentation of pedantic
  (related to issue #7016)

  From the air above Russia...

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@22163 65c4cc65-6c06-0410-ace0-fbb531ad65f3

diff --git a/channels/chan_sip.c b/channels/chan_sip.c
index cfbcb160866fcc6041387dbe3059148117d7a3d2..276577dd16ab5e49f03c29fc14a50f99695fad7e 100644 (file)
--- a/channels/chan_sip.c
+++ b/channels/chan_sip.c
@@ -61,6 +61,8 @@
  * if it's a response to an outbound request, it's sent to handle_response().
  * If it is a request, handle_request sends it to one of a list of functions
  * depending on the request type - INVITE, OPTIONS, REFER, BYE, CANCEL etc
+ * sipsock_read locks the ast_channel if it exists (an active call) and
+ * unlocks it after we have processed the SIP message.
  *
  * A new INVITE is sent to handle_request_invite(), that will end up
  * starting a new channel in the PBX, the new channel after that executing
@@ -11867,6 +11869,7 @@ static int handle_request(struct sip_pvt *p, struct sip_request *req, struct soc
 }
 
 /*! \brief Read data from SIP socket
+\note sipsock_read locks the owner channel while we are processing the SIP message
 \return 1 on error, 0 on success
 \note Successful messages is connected to SIP call and forwarded to handle_request() 
 */
@@ -11924,6 +11927,8 @@ static int sipsock_read(int *id, int fd, short events, void *ignore)
        /* Process request, with netlock held */
 retrylock:
        ast_mutex_lock(&netlock);
+
+       /* Find the active SIP dialog or create a new one */
        p = find_call(&req, &sin, req.method);  /* returns p locked */
        if (p) {
                /* Go ahead and lock the owner if it has one -- we may need it */

diff --git a/configs/sip.conf.sample b/configs/sip.conf.sample
index 3133feee0ade5c699a793fc09463b39f10b52d89..d391ec7c68bace86f2a6fff8dc3bb804c174bb78 100644 (file)
--- a/configs/sip.conf.sample
+++ b/configs/sip.conf.sample
@@ -56,7 +56,8 @@ srvlookup=yes                 ; Enable DNS SRV lookups on outbound calls
                                ; Default is yes
 ;autodomain=yes                        ; Turn this on to have Asterisk add local host
                                ; name and local IP to domain list.
-;pedantic=yes                  ; Enable slow, pedantic checking for Pingtel
+;pedantic=yes                  ; Enable checking of tags in headers, 
+                               ; international character conversions in URIs
                                ; and multiline formatted headers for strict
                                ; SIP compatibility (defaults to "no")