chiark / gitweb /
Version bump.
[mLib] / conn.h
CommitLineData
97f65b00 1/* -*-c-*-
2 *
ff34c6e7 3 * $Id: conn.h,v 1.6 2001/06/22 19:35:20 mdw Exp $
97f65b00 4 *
5 * Nonblocking connect handling
6 *
a3ddb778 7 * (c) 1999 Straylight/Edgeware
97f65b00 8 */
9
10/*----- Licensing notice --------------------------------------------------*
11 *
12 * This file is part of the mLib utilities library.
13 *
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.
18 *
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.
23 *
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,
27 * MA 02111-1307, USA.
28 */
29
30/*----- Revision history --------------------------------------------------*
31 *
32 * $Log: conn.h,v $
ff34c6e7 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
38 * painful.
39 *
c6e0eaf0 40 * Revision 1.5 1999/12/10 23:42:04 mdw
41 * Change header file guard names.
42 *
9da403af 43 * Revision 1.4 1999/05/26 21:08:01 mdw
44 * Remove redundant structure member.
45 *
5feb52af 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.
49 *
a3ddb778 50 * Revision 1.2 1999/05/15 10:33:32 mdw
51 * Fix copyright notices.
52 *
97f65b00 53 * Revision 1.1 1999/05/14 21:01:14 mdw
54 * Integrated `select' handling bits from the background resolver project.
55 *
56 */
57
c6e0eaf0 58#ifndef MLIB_CONN_H
59#define MLIB_CONN_H
97f65b00 60
61#ifdef __cplusplus
62 extern "C" {
63#endif
64
65/*----- Header files ------------------------------------------------------*/
66
5feb52af 67#include <sys/types.h>
68#include <sys/socket.h>
69
c6e0eaf0 70#ifndef MLIB_SEL_H
97f65b00 71# include "sel.h"
72#endif
73
74/*----- Data structures ---------------------------------------------------*/
75
76/* --- The nonblocking connect structure --- */
77
78typedef struct conn {
79 sel_file writer; /* Select listener */
80 void (*func)(int /*fd*/, void */*p*/); /* Handler function */
81 void *p; /* Argument for handler function */
82} conn;
83
84/*----- Functions provided ------------------------------------------------*/
85
86/* --- @conn_init@ --- *
87 *
88 * Arguments: @conn *c@ = pointer to connection block
89 * @sel_state *s@ = pointer to select state to attach to
5feb52af 90 * @int fd@ = file descriptor of socket to connect
91 * @struct sockaddr *dst@ = destination address
92 * @int dsz@ = size of destination address
97f65b00 93 * @void (*func)(int fd, void *p) = handler function
94 * @void *p@ = argument for the handler function
95 *
ff34c6e7 96 * Returns: Zero on success, nonzero on failure.
97f65b00 97 *
5feb52af 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.
97f65b00 105 */
106
ff34c6e7 107extern int conn_init(conn */*c*/, sel_state */*s*/, int /*fd*/,
108 struct sockaddr */*dst*/, int /*dsz*/,
109 void (*/*func*/)(int /*fd*/, void */*p*/),
110 void */*p*/);
97f65b00 111
112/* --- @conn_kill@ --- *
113 *
114 * Arguments: @conn *c@ = pointer to connection to dispose of
115 *
116 * Returns: ---
117 *
118 * Use: Disposes of a connection when it's not wanted any more. The
119 * connect handler function is not called.
120 */
121
122extern void conn_kill(conn */*c*/);
123
124/*----- That's all, folks -------------------------------------------------*/
125
126#ifdef __cplusplus
127 }
128#endif
129
130#endif