1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
/* Copyright (C) 2011 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/*!
* \file fdset_epoll.h
*
* \author Marek Vavrusa <marek.vavrusa@nic.cz>
*
* \brief Wrapper for epoll I/O multiplexing.
*
* \addtogroup common_lib
* @{
*/
#ifndef _KNOTD_FDSET_EPOLL_H_
#define _KNOTD_FDSET_EPOLL_H_
#include "fdset.h"
/*!
* \brief Create new fdset.
*
* Linux epoll() backend.
*
* \retval Pointer to initialized FDSET structure if successful.
* \retval NULL on error.
*/
fdset_t *fdset_epoll_new();
/*!
* \brief Destroy FDSET.
*
* \retval 0 if successful.
* \retval -1 on error.
*/
int fdset_epoll_destroy(fdset_t * fdset);
/*!
* \brief Add file descriptor to watched set.
*
* \param fdset Target set.
* \param fd Added file descriptor.
* \param events Mask of watched events.
*
* \retval 0 if successful.
* \retval -1 on errors.
*/
int fdset_epoll_add(fdset_t *fdset, int fd, int events);
/*!
* \brief Remove file descriptor from watched set.
*
* \param fdset Target set.
* \param fd File descriptor to be removed.
*
* \retval 0 if successful.
* \retval -1 on errors.
*/
int fdset_epoll_remove(fdset_t *fdset, int fd);
/*!
* \brief Poll set for new events.
*
* \param fdset Target set.
* \param timeout Timeout (OS_EV_FOREVER, OS_EV_NOWAIT or value in miliseconds).
*
* \retval Number of events if successful.
* \retval -1 on errors.
*/
int fdset_epoll_wait(fdset_t *fdset, int timeout);
/*!
* \brief Set event iterator to the beginning of last polled events.
*
* \param fdset Target set.
* \param it Event iterator.
*
* \retval 0 if successful.
* \retval -1 on errors.
*/
int fdset_epoll_begin(fdset_t *fdset, fdset_it_t *it);
/*!
* \brief Set event iterator to the end of last polled events.
*
* \param fdset Target set.
* \param it Event iterator.
*
* \retval 0 if successful.
* \retval -1 on errors.
*/
int fdset_epoll_end(fdset_t *fdset, fdset_it_t *it);
/*!
* \brief Set event iterator to the next event.
*
* Event iterator fd will be set to -1 if next event doesn't exist.
*
* \param fdset Target set.
* \param it Event iterator.
*
* \retval 0 if successful.
* \retval -1 on errors.
*/
int fdset_epoll_next(fdset_t *fdset, fdset_it_t *it);
/*!
* \brief Returned name of epoll method.
*
* \retval Name if successful.
* \retval NULL if no method was loaded (shouldn't happen).
*/
const char* fdset_epoll_method();
/*! \brief Exported API. */
extern struct fdset_backend_t FDSET_EPOLL;
#endif /* _KNOTD_FDSET_EPOLL_H_ */
/*! @} */
|
