Changeset 5697 for pjproject/trunk/pjsip/include/pjsip/sip_parser.h

Timestamp:

Nov 17, 2017 4:07:43 AM (6 years ago)

Author:

ming

Message:

Re #2063: Add more doc in other parts of the library

File:

• pjproject/trunk/pjsip/include/pjsip/sip_parser.h (modified) (1 diff)

pjproject/trunk/pjsip/include/pjsip/sip_parser.h

@@ -280 +280 @@
  * Check incoming packet to see if a (probably) valid SIP message has been 
  * received.
- * Note that the input string buffer MUST be NULL terminated.
+ * Note that the input string buffer MUST be NULL terminated and have
+ * length at least size+1 (size MUST NOT include the NULL terminator).
  *
  * @param buf           The input buffer, which must be NULL terminated.
- * @param size          The buffer size.
+ * @param size          The length of the string (not counting NULL terminator).
  * @param is_datagram   Put non-zero if transport is datagram oriented.
  * @param msg_size      [out] If message is valid, this parameter will contain