Changeset 3118 for pjproject/trunk

Timestamp:

Mar 8, 2010 3:25:17 AM (15 years ago)

Author:

bennylp

Message:

Misc (#1026): added more documentation for PJNATH_EICEFAILED error code

File:

• pjproject/trunk/pjnath/include/pjnath/errno.h (modified) (1 diff)

pjproject/trunk/pjnath/include/pjnath/errno.h

@@ -155 +155 @@
 /**
  * @hideinitializer
- * All ICE checklists failed
+ * This error indicates that ICE connectivity check has failed, because
+ * there is at least one ICE component that does not have a valid check.
+ * Normally this happens because the network topology had caused the
+ * connectivity check to fail (e.g. no route between the two agents),
+ * however other reasons may include software incompatibility between
+ * the two agents, or incomplete candidates gathered by the agent(s).
  */
 #define PJNATH_EICEFAILED           (PJNATH_ERRNO_START+82) /* 370082 */