Changeset 43 for pjproject/main/pjsip/include/pjsip/sip_parser.h

Timestamp:

Nov 11, 2005 7:01:31 PM (18 years ago)

Author:

bennylp

Message:

First clean compile of pjsip

File:

• pjproject/main/pjsip/include/pjsip/sip_parser.h (modified) (9 diffs, 1 prop)

pjproject/main/pjsip/include/pjsip/sip_parser.h

@@ -1 +1 @@
 /* $Id$
- *
  */
 #ifndef __PJSIP_SIP_PARSER_H__
@@ -11 +10 @@
 
 #include <pjsip/sip_types.h>
-#include <pj/scanner.h>
+#include <pjlib-util/scanner.h>
 #include <pj/list.h>
 
@@ -52 +51 @@
 typedef struct pjsip_parser_err_report
 {
-    PJ_DECL_LIST_MEMBER(struct pjsip_parser_err_report)
+    PJ_DECL_LIST_MEMBER(struct pjsip_parser_err_report);
     int         exception_code; /**< Error exception (e.g. PJSIP_SYN_ERR_EXCEPTION) */
     int         line;           /**< Line number. */
@@ -58 +57 @@
     pj_str_t    hname;          /**< Header name, if any. */
 } pjsip_parser_err_report;
+
+
+/**
+ * Parsing context, the default argument for parsing functions.
+ */
+typedef struct pjsip_parse_ctx
+{
+    pj_scanner      *scanner;   /**< The scanner.       */
+    pj_pool_t       *pool;      /**< The pool.          */
+    pjsip_rx_data   *rdata;     /**< Optional rdata.    */
+} pjsip_parse_ctx;
 
 
@@ -77 +87 @@
  *        can be terminated when seeing EOF.
  */
-typedef void* (pjsip_parse_hdr_func)(pj_scanner *scanner, pj_pool_t *pool);
+typedef pjsip_hdr* (pjsip_parse_hdr_func)(pjsip_parse_ctx *context);
 
 /**
@@ -95 +105 @@
  * @param fptr          The pointer to function to parser the header.
  *
- * @return              zero if success.
- * @see pjsip_parse_hdr_func
+ * @return              PJ_SUCCESS if success, or the appropriate error code.
  */
 PJ_DECL(pj_status_t) pjsip_register_hdr_parser( const char *hname,
@@ -186 +195 @@
 
 /**
+ * Parse a packet buffer and build a rdata. The resulting message will be
+ * stored in \c msg field in the \c rdata. This behaves pretty much like
+ * #pjsip_parse_msg(), except that it will also initialize the header fields
+ * in the \c rdata.
+ *
+ * This function is normally called by the transport layer.
+ *
+ * @param buf           The input buffer
+ * @param buf           The input buffer, which size must be at least (size+1)
+ *                      because the function will temporarily put NULL 
+ *                      termination at the end of the buffer during parsing.
+ * @param size          The length of the string (not counting NULL terminator).
+ * @param rdata         The receive data buffer to store the message and
+ *                      its elements.
+ *
+ * @return              The message inside the rdata if successfull, or NULL.
+ */
+PJ_DECL(pjsip_msg *) pjsip_parse_rdata( char *buf, pj_size_t size,
+                                        pjsip_rx_data *rdata );
+
+/**
  * Check incoming packet to see if a (probably) valid SIP message has been 
  * received.
@@ -194 +224 @@
  *                      the size of the SIP message (including body, if any).
  *
- * @return              PJ_TRUE (1) if a message is found.
- */
-PJ_DECL(pj_bool_t) pjsip_find_msg( const char *buf, pj_size_t size, 
-                                   pj_bool_t is_datagram, pj_size_t *msg_size);
+ * @return              PJ_SUCCESS if a message is found, or an error code.
+ */
+PJ_DECL(pj_status_t) pjsip_find_msg(const char *buf, 
+                                    pj_size_t size, 
+                                    pj_bool_t is_datagram, 
+                                    pj_size_t *msg_size);
 
 /**
@@ -248 +280 @@
  */
 extern
-pj_char_spec    pjsip_HOST_SPEC,            /* For scanning host part. */
+pj_cis_t        pjsip_HOST_SPEC,            /* For scanning host part. */
                 pjsip_DIGIT_SPEC,           /* Decimal digits */
                 pjsip_ALPHA_SPEC,           /* Alpha (A-Z, a-z) */