Changeset 993 for pjproject/trunk/pjlib-util/include/pjlib-util/stun_msg.h

Timestamp:

Feb 22, 2007 2:09:23 AM (17 years ago)

Author:

bennylp

Message:

Continuing work on the new STUN framework, partly implemented the client session

File:

• pjproject/trunk/pjlib-util/include/pjlib-util/stun_msg.h (modified) (4 diffs)

pjproject/trunk/pjlib-util/include/pjlib-util/stun_msg.h

@@ -1191 +1191 @@
 
 /**
+ * Dump STUN message to a printable string output.
+ *
+ * @param msg           The STUN message
+ * @param buffer        Buffer where the printable string output will
+ *                      be printed on.
+ * @param length        On input, specify the maximum length of the buffer.
+ *                      On output, it will be filled up with the actual
+ *                      length of the output string.
+ *
+ * @return              The message string output.
+ */
+PJ_DECL(char*) pj_stun_msg_dump(const pj_stun_msg *msg,
+                                char *buffer,
+                                unsigned *length);
+
+
+/**
  * Find STUN attribute in the STUN message, starting from the specified
  * index.
  *
  * @param msg           The STUN message.
- * @param attr_type     The attribute type to be found.
+ * @param attr_type     The attribute type to be found, from pj_stun_attr_type.
  * @param start_index   The start index of the attribute in the message.
  *                      Specify zero to start searching from the first
@@ -1213 +1230 @@
  *
  * @param pool          The pool to allocate memory from.
- * @param attr_type     Attribute type.
+ * @param attr_type     Attribute type, from #pj_stun_attr_type.
  * @param xor_ed        If non-zero, the port and address will be XOR-ed
  *                      with magic, to make the XOR-MAPPED-ADDRESS attribute.
@@ -1235 +1252 @@
  *
  * @param pool          The pool to allocate memory from.
+ * @param attr_type     Attribute type, from #pj_stun_attr_type.
  * @param value         The string value to be assigned to the attribute.
  * @param p_attr        Pointer to receive the attribute.
@@ -1316 +1334 @@
  *
  * @param pool          The pool to allocate memory from.
- * @param attr_type     The attribute type.
+ * @param attr_type     The attribute type, from #pj_stun_attr_type.
  * @param p_attr        Pointer to receive the attribute.
  *