X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/mLib/blobdiff_plain/5feb52afba684ae49cc96f66fd62fc190c251b92..5934f1eea5364e8a62b40f09fc41c1fbdf024868:/conn.h

diff --git a/conn.h b/conn.h
index e70595c..d381850 100644
--- a/conn.h
+++ b/conn.h
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: conn.h,v 1.3 1999/05/23 12:12:46 mdw Exp $
+ * $Id: conn.h,v 1.7 2003/11/29 19:10:53 mdw Exp $
  *
  * Nonblocking connect handling
  *
@@ -30,6 +30,22 @@
 /*----- Revision history --------------------------------------------------* 
  *
  * $Log: conn.h,v $
+ * Revision 1.7  2003/11/29 19:10:53  mdw
+ * Declare and document @conn_fd@.
+ *
+ * Revision 1.6  2001/06/22 19:35:20  mdw
+ * Interface change to @conn_init@ -- return error rather than calling the
+ * function.  This reduces the number of different environments the
+ * callback has to cope with, and the old behaviour is easily simulatable
+ * with the new, while simulating the new behaviour was awkward and
+ * painful.
+ *
+ * Revision 1.5  1999/12/10 23:42:04  mdw
+ * Change header file guard names.
+ *
+ * Revision 1.4  1999/05/26 21:08:01  mdw
+ * Remove redundant structure member.
+ *
  * Revision 1.3  1999/05/23 12:12:46  mdw
  * Interface change to make the `conn' selector useful for generic stream
  * sockets rather than just IPv4 ones.
@@ -42,8 +58,8 @@
  *
  */
 
-#ifndef CONN_H
-#define CONN_H
+#ifndef MLIB_CONN_H
+#define MLIB_CONN_H
 
 #ifdef __cplusplus
   extern "C" {
@@ -54,7 +70,7 @@
 #include <sys/types.h>
 #include <sys/socket.h>
 
-#ifndef SEL_H
+#ifndef MLIB_SEL_H
 #  include "sel.h"
 #endif
 
@@ -65,12 +81,29 @@
 typedef struct conn {
   sel_file writer;			/* Select listener */
   void (*func)(int /*fd*/, void */*p*/); /* Handler function */
-  int dsz;				/* Size of destination address */
   void *p;				/* Argument for handler function */
 } conn;
 
 /*----- Functions provided ------------------------------------------------*/
 
+/* --- @conn_fd@ --- *
+ *
+ * Arguments:	@conn *c@ = pointer to connection block
+ *		@sel_state *s@ = pointer to select state to attach to
+ *		@int fd@ = file descriptor of socket
+ *		@void (*func)(int fd, void *p) = handler function
+ *		@void *p@ = argument for the handler function
+ *
+ * Returns:	---
+ *
+ * Use:		Sets up a nonblocking connect job.  The socket should have a
+ *		connect pending for it already.
+ */
+
+void conn_fd(conn */*c*/, sel_state */*s*/, int /*fd*/,
+	     void (*/*func*/)(int /*fd*/, void */*p*/),
+	     void */*p*/);
+
 /* --- @conn_init@ --- *
  *
  * Arguments:	@conn *c@ = pointer to connection block
@@ -81,7 +114,7 @@ typedef struct conn {
  *		@void (*func)(int fd, void *p) = handler function
  *		@void *p@ = argument for the handler function
  *
- * Returns:	---
+ * Returns:	Zero on success, nonzero on failure.
  *
  * Use:		Sets up a nonblocking connect job.  The socket should already
  *		be bound if you care about that sort of thing.  When the
@@ -92,10 +125,10 @@ typedef struct conn {
  *		In either case, the select job is then removed.
  */
 
-extern void conn_init(conn */*c*/, sel_state */*s*/, int /*fd*/,
-		      struct sockaddr */*dst*/, int /*dsz*/,
-		      void (*/*func*/)(int /*fd*/, void */*p*/),
-		      void */*p*/);
+extern int conn_init(conn */*c*/, sel_state */*s*/, int /*fd*/,
+		     struct sockaddr */*dst*/, int /*dsz*/,
+		     void (*/*func*/)(int /*fd*/, void */*p*/),
+		     void */*p*/);
 
 /* --- @conn_kill@ --- *
  *