3 * $Id: selpk.h,v 1.4 2004/04/08 01:36:13 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,
37 /*----- Header files ------------------------------------------------------*/
47 /*----- Data structures ---------------------------------------------------*/
49 typedef struct selpk
{
50 sel_file reader
; /* File selection object */
51 pkbuf pk
; /* Packet buffering object */
54 /*----- Functions provided ------------------------------------------------*/
56 /* --- @selpk_enable@ --- *
58 * Arguments: @selpk *pk@ = pointer to buffer block
62 * Use: Enables a buffer for reading, and emits any queued packets
63 * to the buffer's owner.
66 extern void selpk_enable(selpk */
*pk*/
);
68 /* --- @selpk_disable@ --- *
70 * Arguments: @selpk *pk@ = pointer to a buffer block
74 * Use: Disables a buffer. It won't be read from until it's
78 extern void selpk_disable(selpk */
*pk*/
);
80 /* --- @selpk_want@ --- *
82 * Arguments: @selpk *pk@ = pointer to buffer block
83 * @size_t want@ = size of packet to read
87 * Use: Sets the size of the packet to be read next.
90 extern void selpk_want(selpk */
*pk*/
, size_t /*sz*/);
92 /* --- @selpk_init@ --- *
94 * Arguments: @selpk *pk@ = pointer to buffer block
95 * @sel_state *s@ = pointer to select state to attach to
96 * @int fd@ = file descriptor to listen to
97 * @pkbuf_func *func@ = function to call
98 * @void *p@ = argument for function
102 * Use: Initializes a buffer block.
105 extern void selpk_init(selpk */
*pk*/
, sel_state */
*s*/
, int /*fd*/,
106 pkbuf_func */
*func*/
, void */
*p*/
);
108 /* --- @selpk_destroy@ --- *
110 * Arguments: @lbuf *b@ = pointer to buffer block
114 * Use: Deallocates a packet buffer and frees any resources it owned.
117 extern void selpk_destroy(selpk */
*pk*/
);
119 /*----- That's all, folks -------------------------------------------------*/