[Pvfs2-cvs] commit by pw in pvfs2/src/io/bmi: bmi.c

[CVS commit program]

Update of /projects/cvsroot/pvfs2/src/io/bmi
In directory parlweb1:/tmp/cvs-serv27961/src/io/bmi

Modified Files:
	bmi.c 
Log Message:
explain a bit more what the bmi method_addr_reg callback is for


Index: bmi.c
===================================================================
RCS file: /projects/cvsroot/pvfs2/src/io/bmi/bmi.c,v
diff -u -p -p -u -r1.77 -r1.78
--- bmi.c	7 Dec 2006 21:47:46 -0000	1.77
+++ bmi.c	9 Dec 2006 16:28:24 -0000	1.78
@@ -1786,7 +1786,13 @@ int BMI_cancel(bmi_op_id_t id, 
 /* bmi_method_addr_reg_callback()
  * 
  * Used by the methods to register new addresses when they are
- * discovered.
+ * discovered.  Only call this method when the device gets an
+ * unexpected receive from a new peer, i.e., if you do the equivalent
+ * of a socket accept() and get a new connection.
+ *
+ * Do not call this function for active lookups, that is from your
+ * BMI_meth_method_addr_lookup.  BMI already knows about the address in
+ * this case, since the user provided it.
  *
  * returns 0 on success, -errno on failure
  */