3 * $Id: reffd.h,v 1.1 1999/07/26 23:33:01 mdw Exp $
5 * Reference counted file descriptors
7 * (c) 1999 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of the `fw' port forwarder.
14 * `fw' is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * `fw' 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 General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with `fw'; if not, write to the Free Software Foundation,
26 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 /*----- Revision history --------------------------------------------------*
32 * Revision 1.1 1999/07/26 23:33:01 mdw
33 * Infrastructure for the new design.
44 /*----- Header files ------------------------------------------------------*/
50 /*----- Data structures ---------------------------------------------------*/
52 typedef struct reffd
{
55 void (*proc
)(void */
*p*/
);
59 /*----- Functions provided ------------------------------------------------*/
61 /* --- @reffd_init@ --- *
63 * Arguments: @int fd@ = file descriptor
65 * Returns: Reference-counted file descriptor object.
67 * Use: Creates a refcounted file descriptor.
70 extern reffd
*reffd_init(int /*fd*/);
72 /* --- @reffd_handler@ --- *
74 * Arguments: @reffd *r@ = pointer to reference counted filehandle
75 * @void (*proc)(void *p)@ = procedure to call
80 * Use: Sets the reference counted file descriptor to call @proc@
81 * when it is no longer required.
84 extern void reffd_handler(reffd */
*r*/
, void (*/
*proc*/
)(void */
*p*/
),
87 /* --- @reffd_inc@ --- *
89 * Arguments: @reffd *r@ = pointer to reference counted filehandle
93 * Use: Increments the reference count for a file descriptor.
96 #define REFFD_INC(r) do { (r)->ref++; } while (0)
98 extern void reffd_inc(reffd */
*r*/
);
100 /* --- @reffd_dec@ --- *
102 * Arguments: @reffd *r@ = pointer to reference counted filehandle
106 * Use: Decrements the reference count for a file descriptor.
109 #define REFFD_DEC(r) do { \
112 if (_r->ref == 0) { \
120 extern void reffd_dec(reffd */
*r*/
);
122 /*----- That's all, folks -------------------------------------------------*/