Kannel: Open Source WAP and SMS gateway  $Revision: 5037 $
fdset.h
Go to the documentation of this file.
1 /* ====================================================================
2  * The Kannel Software License, Version 1.0
3  *
4  * Copyright (c) 2001-2016 Kannel Group
5  * Copyright (c) 1998-2001 WapIT Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Kannel Group (http://www.kannel.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Kannel" and "Kannel Group" must not be used to
28  * endorse or promote products derived from this software without
29  * prior written permission. For written permission, please
30  * contact org@kannel.org.
31  *
32  * 5. Products derived from this software may not be called "Kannel",
33  * nor may "Kannel" appear in their name, without prior written
34  * permission of the Kannel Group.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE KANNEL GROUP OR ITS CONTRIBUTORS
40  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
41  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
42  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
43  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
44  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
45  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
46  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Kannel Group. For more information on
51  * the Kannel Group, please see <http://www.kannel.org/>.
52  *
53  * Portions of this software are based upon software originally written at
54  * WapIT Ltd., Helsinki, Finland for the Kannel project.
55  */
56 
57 /*
58  * fdset.h - module for managing a large collection of file descriptors
59  */
60 
61 typedef struct FDSet FDSet;
62 
63 /*
64  * A function of this type will be called to indicate that a file descriptor
65  * has shown activity. The revents parameter is in the same format as
66  * returned by poll(). The data pointer was supplied by the caller who
67  * registered the fd with us in the first place.
68  * NOTE: Beware of concurrency issues. The callback function will run
69  * in the fdset's private thread, not in the caller's thread.
70  * This also means that if the callback does a lot of work it will slow
71  * down the polling process. This may be good or bad.
72  */
73 typedef void fdset_callback_t(int fd, int revents, void *data);
74 
75 /*
76  * Create a new, empty file descriptor set and start its thread.
77  * @timeout - idle timeout for any filedescriptor in this fdset after which
78  * callback function will be called with POLLERR as event.
79  */
80 #define fdset_create() fdset_create_real(-1)
82 
83 /*
84  * Destroy a file descriptor set. Will emit a warning if any file
85  * descriptors are still registered with it.
86  */
87 void fdset_destroy(FDSet *set);
88 
89 /*
90  * Register a file descriptor with this set, and listen for the specified
91  * events (see fdset_listen() for details on that). Record the callback
92  * function which will be used to notify the caller about events.
93  */
94 void fdset_register(FDSet *set, int fd, int events,
95  fdset_callback_t callback, void *data);
96 
97 /*
98  * Change the set of events to listen for for this file descriptor.
99  * Events is in the same format as the events field in poll() -- in
100  * practice, use POLLIN for "input available", POLLOUT for "ready to
101  * accept more output", and POLLIN|POLLOUT for both.
102  *
103  * The mask field indicates which event flags can be affected. For
104  * example, if events is POLLIN and mask is POLLIN, then the POLLOUT
105  * setting will not be changed by this. If mask were POLLIN|POLLOUT,
106  * then the POLLOUT setting would be turned off.
107  *
108  * The fd must first have been registered. Locks are used to
109  * guarantee that the callback function will not be called for
110  * the old events after this function returns.
111  */
112 void fdset_listen(FDSet *set, int fd, int mask, int events);
113 
114 /*
115  * Forget about this fd. Locks are used to guarantee that the callback
116  * function will not be called for this fd after this function returns.
117  */
118 void fdset_unregister(FDSet *set, int fd);
119 
123 void fdset_set_timeout(FDSet *set, long timeout);
void fdset_set_timeout(FDSet *set, long timeout)
Definition: fdset.c:547
FDSet * fdset_create_real(long timeout)
Definition: fdset.c:368
void fdset_callback_t(int fd, int revents, void *data)
Definition: fdset.h:73
void fdset_register(FDSet *set, int fd, int events, fdset_callback_t callback, void *data)
Definition: fdset.c:425
long timeout
Definition: fdset.c:91
void fdset_unregister(FDSet *set, int fd)
Definition: fdset.c:510
Definition: fdset.c:70
void fdset_listen(FDSet *set, int fd, int mask, int events)
Definition: fdset.c:470
void fdset_destroy(FDSet *set)
Definition: fdset.c:398
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.