3 * $Id: selpk.h,v 1.3 2002/01/13 13:33:51 mdw Exp $
5 * Packet-buffering select handler
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.3 2002/01/13 13:33:51 mdw
34 * Packet handler functions now have a @typedef@ name.
36 * Revision 1.2 2000/07/16 18:56:00 mdw
37 * Fix a function declaration which slipped through the net.
39 * Revision 1.1 2000/06/17 10:39:19 mdw
40 * Experimental new support for packet buffering.
51 /*----- Header files ------------------------------------------------------*/
61 /*----- Data structures ---------------------------------------------------*/
63 typedef struct selpk
{
64 sel_file reader
; /* File selection object */
65 pkbuf pk
; /* Packet buffering object */
68 /*----- Functions provided ------------------------------------------------*/
70 /* --- @selpk_enable@ --- *
72 * Arguments: @selpk *pk@ = pointer to buffer block
76 * Use: Enables a buffer for reading, and emits any queued packets
77 * to the buffer's owner.
80 extern void selpk_enable(selpk */
*pk*/
);
82 /* --- @selpk_disable@ --- *
84 * Arguments: @selpk *pk@ = pointer to a buffer block
88 * Use: Disables a buffer. It won't be read from until it's
92 extern void selpk_disable(selpk */
*pk*/
);
94 /* --- @selpk_want@ --- *
96 * Arguments: @selpk *pk@ = pointer to buffer block
97 * @size_t want@ = size of packet to read
101 * Use: Sets the size of the packet to be read next.
104 extern void selpk_want(selpk */
*pk*/
, size_t /*sz*/);
106 /* --- @selpk_init@ --- *
108 * Arguments: @selpk *pk@ = pointer to buffer block
109 * @sel_state *s@ = pointer to select state to attach to
110 * @int fd@ = file descriptor to listen to
111 * @pkbuf_func *func@ = function to call
112 * @void *p@ = argument for function
116 * Use: Initializes a buffer block.
119 extern void selpk_init(selpk */
*pk*/
, sel_state */
*s*/
, int /*fd*/,
120 pkbuf_func */
*func*/
, void */
*p*/
);
122 /* --- @selpk_destroy@ --- *
124 * Arguments: @lbuf *b@ = pointer to buffer block
128 * Use: Deallocates a packet buffer and frees any resources it owned.
131 extern void selpk_destroy(selpk */
*pk*/
);
133 /*----- That's all, folks -------------------------------------------------*/