Changeset 1914

Timestamp:

Apr 9, 2008 12:08:08 PM (16 years ago)

Author:

bennylp

Message:

Improve the PJNATH documentation

Location:

pjproject/trunk/pjnath

Files:

• include/pjnath/turn_session.h (modified) (1 diff)
• include/pjnath/types.h (modified) (2 diffs)
• src/pjnath/turn_session.c (modified) (1 diff)
• src/pjnath/turn_sock.c (modified) (1 diff)
• src/pjturn-client/client_main.c (modified) (1 diff)

pjproject/trunk/pjnath/include/pjnath/turn_session.h

@@ -309 +309 @@
  * Set credential to be used by the session.
  */
-PJ_DECL(pj_status_t) pj_turn_session_set_cred(pj_turn_session *sess,
+PJ_DECL(pj_status_t) pj_turn_session_set_credential(pj_turn_session *sess,
                                               const pj_stun_auth_cred *cred);
 

pjproject/trunk/pjnath/include/pjnath/types.h

@@ -141 +141 @@
  * 
  *
+ * \n
+ *
+ * \subsection PJNATH_STUN_CLASSES PJNATH Class Diagram
+ *
+ * 
+ * \image html UML-class-diagram.png "Class Diagram"
+ *
+ * TBD: write descriptions.
+ *
  * \subsection PJNATH_STUN_USING Using STUN Library
  *
@@ -156 +165 @@
  * References for STUN:
  *
- *  - <A HREF="http://www.ietf.org/internet-drafts/draft-ietf-behave-rfc3489bis-11.txt">
- *    <B>draft-ietf-behave-rfc3489bis-11</b></A>: Session Traversal 
+ *  - <A HREF="http://www.ietf.org/internet-drafts/draft-ietf-behave-rfc3489bis-15.txt">
+ *    <B>draft-ietf-behave-rfc3489bis-15</b></A>: Session Traversal 
  *     Utilities for (NAT) (STUN),
- *  - <A HREF="http://www.ietf.org/internet-drafts/draft-ietf-behave-turn-03.txt">
- *    <B>draft-ietf-behave-turn-03</B></A>: Obtaining Relay Addresses 
+ *  - <A HREF="http://www.ietf.org/internet-drafts/draft-ietf-behave-turn-07.txt">
+ *    <B>draft-ietf-behave-turn-07</B></A>: Obtaining Relay Addresses 
  *    from Simple Traversal Underneath NAT (STUN)
  *  - Obsoleted: <A HREF="http://www.ietf.org/rfc/rfc3489.txt">RFC 3489</A>.

pjproject/trunk/pjnath/src/pjnath/turn_session.c

@@ -556 +556 @@
  * Set credential to be used by the session.
  */
-PJ_DEF(pj_status_t) pj_turn_session_set_cred(pj_turn_session *sess,
+PJ_DEF(pj_status_t) pj_turn_session_set_credential(pj_turn_session *sess,
                                              const pj_stun_auth_cred *cred)
 {
     PJ_ASSERT_RETURN(sess && cred, PJ_EINVAL);
+    PJ_ASSERT_RETURN(sess->stun, PJ_EINVALIDOP);
 
     pj_lock_acquire(sess->lock);

pjproject/trunk/pjnath/src/pjnath/turn_sock.c

@@ -336 +336 @@
     /* Set credental */
     if (cred) {
-        status = pj_turn_session_set_cred(turn_sock->sess, cred);
+        status = pj_turn_session_set_credential(turn_sock->sess, cred);
         if (status != PJ_SUCCESS) {
             sess_fail(turn_sock, "Error setting credential", status);

pjproject/trunk/pjnath/src/pjturn-client/client_main.c

@@ -420 +420 @@
                 my_perror("turn_udp_bind_channel() failed", status);
             break;
-        case 'd':
-            pj_pool_factory_dump(&g.cp.factory, PJ_TRUE);
-            break;
         case 'x':
             if (g.relay == NULL) {