blast: Upper-case metasyntactic variables in the usage message.

[fwd] / endpt.h

diff --git a/endpt.h b/endpt.h
index fb44aa9..f854497 100644 (file)
--- a/endpt.h
+++ b/endpt.h
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: endpt.h,v 1.1 1999/07/26 23:33:01 mdw Exp $
+ * $Id: endpt.h,v 1.3 2004/04/08 01:36:25 mdw Exp $
  *
  * Generic endpoint abstraction
  *
@@ -26,14 +26,6 @@
  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  */
 
-/*----- Revision history --------------------------------------------------* 
- *
- * $Log: endpt.h,v $
- * Revision 1.1  1999/07/26 23:33:01  mdw
- * Infrastructure for the new design.
- *
- */
-
 #ifndef ENDPT_H
 #define ENDPT_H
 
@@ -81,6 +73,22 @@ typedef struct endpt_ops {
 
   void (*attach)(endpt */*e*/, reffd */*in*/, reffd */*out*/);
 
+  /* --- @file@ --- *
+   *
+   * Arguments:        @endpt *e@ = pointer to endpoint in question
+   *           @endpt *f@ = pointer to a file endpoint
+   *
+   * Returns:  ---
+   *
+   * Use:      Informs a non-file endpoint of a file endpoint which will
+   *           want to be closed when it's finished with.  At that time, the
+   *           endpoint should arrange to have both itself and its partner
+   *           closed.  If no file is registered, the endpoint manager will
+   *           close both endpoints itself.
+   */
+
+  void (*file)(endpt */*e*/, endpt */*f*/);
+
   /* --- @wclose@ --- *
    *
    * Arguments:        @endpt *e@ = endpoint to be partially closed