3 * $Id: conn.h,v 1.6 2001/06/22 19:35:20 mdw Exp $
5 * Nonblocking connect handling
7 * (c) 1999 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of the mLib utilities library.
14 * mLib is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * mLib is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with mLib; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /*----- Revision history --------------------------------------------------*
33 * Revision 1.6 2001/06/22 19:35:20 mdw
34 * Interface change to @conn_init@ -- return error rather than calling the
35 * function. This reduces the number of different environments the
36 * callback has to cope with, and the old behaviour is easily simulatable
37 * with the new, while simulating the new behaviour was awkward and
40 * Revision 1.5 1999/12/10 23:42:04 mdw
41 * Change header file guard names.
43 * Revision 1.4 1999/05/26 21:08:01 mdw
44 * Remove redundant structure member.
46 * Revision 1.3 1999/05/23 12:12:46 mdw
47 * Interface change to make the `conn' selector useful for generic stream
48 * sockets rather than just IPv4 ones.
50 * Revision 1.2 1999/05/15 10:33:32 mdw
51 * Fix copyright notices.
53 * Revision 1.1 1999/05/14 21:01:14 mdw
54 * Integrated `select' handling bits from the background resolver project.
65 /*----- Header files ------------------------------------------------------*/
67 #include <sys/types.h>
68 #include <sys/socket.h>
74 /*----- Data structures ---------------------------------------------------*/
76 /* --- The nonblocking connect structure --- */
79 sel_file writer; /* Select listener */
80 void (*func)(int /*fd*/, void */*p*/); /* Handler function */
81 void *p; /* Argument for handler function */
84 /*----- Functions provided ------------------------------------------------*/
86 /* --- @conn_init@ --- *
88 * Arguments: @conn *c@ = pointer to connection block
89 * @sel_state *s@ = pointer to select state to attach to
90 * @int fd@ = file descriptor of socket to connect
91 * @struct sockaddr *dst@ = destination address
92 * @int dsz@ = size of destination address
93 * @void (*func)(int fd, void *p) = handler function
94 * @void *p@ = argument for the handler function
96 * Returns: Zero on success, nonzero on failure.
98 * Use: Sets up a nonblocking connect job. The socket should already
99 * be bound if you care about that sort of thing. When the
100 * connection completes, the handler function is called with the
101 * connected socket as an argument. If the connect fails rather
102 * than completes, the socket is closed, and the handler is
103 * informed of this by being passed a negative file descriptor.
104 * In either case, the select job is then removed.
107 extern int conn_init(conn */*c*/, sel_state */*s*/, int /*fd*/,
108 struct sockaddr */*dst*/, int /*dsz*/,
109 void (*/*func*/)(int /*fd*/, void */*p*/),
112 /* --- @conn_kill@ --- *
114 * Arguments: @conn *c@ = pointer to connection to dispose of
118 * Use: Disposes of a connection when it's not wanted any more. The
119 * connect handler function is not called.
122 extern void conn_kill(conn */*c*/);
124 /*----- That's all, folks -------------------------------------------------*/