1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/genericopenlibs/openenvcore/include/sys/event.dosc Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,370 @@
1.4 +/** @file ../include/sys/event.h
1.5 +@internalComponent
1.6 +*/
1.7 +
1.8 +/** @def EVFILT_READ
1.9 +
1.10 +They are some pre-defined system filter
1.11 +
1.12 +@publishedAll
1.13 +@externallyDefinedApi
1.14 +*/
1.15 +
1.16 +
1.17 +/** @def EVFILT_WRITE
1.18 +
1.19 +They are some pre-defined system filter
1.20 +
1.21 +@publishedAll
1.22 +@externallyDefinedApi
1.23 +*/
1.24 +
1.25 +/** @def EVFILT_AIO
1.26 +
1.27 +attached to aio requests
1.28 +
1.29 +@publishedAll
1.30 +@released
1.31 +*/
1.32 +
1.33 +
1.34 +
1.35 +/** @def EVFILT_VNODE
1.36 +
1.37 +attached to vnodes
1.38 +
1.39 +@publishedAll
1.40 +@externallyDefinedApi
1.41 +*/
1.42 +
1.43 +
1.44 +/** @def EVFILT_PROC
1.45 +
1.46 +attached to struct proc
1.47 +
1.48 +@publishedAll
1.49 +@externallyDefinedApi
1.50 +*/
1.51 +
1.52 +
1.53 +/** @def EVFILT_SIGNAL
1.54 +
1.55 +attached to struct proc
1.56 +
1.57 +@publishedAll
1.58 +@externallyDefinedApi
1.59 +*/
1.60 +
1.61 +/** @def EVFILT_TIMER
1.62 +
1.63 +timers
1.64 +
1.65 +@publishedAll
1.66 +@externallyDefinedApi
1.67 +*/
1.68 +
1.69 +
1.70 +/** @def EVFILT_NETDEV
1.71 +
1.72 +network devices
1.73 +
1.74 +@publishedAll
1.75 +@externallyDefinedApi
1.76 +*/
1.77 +
1.78 +/** @def EVFILT_FS
1.79 +
1.80 +filesystem events
1.81 +
1.82 +@publishedAll
1.83 +@released
1.84 +*/
1.85 +
1.86 +/** @struct kevent
1.87 +
1.88 +Contains the following members,
1.89 +
1.90 +@publishedAll
1.91 +@externallyDefinedApi
1.92 +*/
1.93 +
1.94 +/** @var kevent::ident
1.95 +identifier for this event
1.96 +*/
1.97 +
1.98 +/** @var kevent::filter
1.99 +filter for event
1.100 +*/
1.101 +
1.102 +/** @var kevent::flags
1.103 +action flags for kqueue
1.104 +*/
1.105 +
1.106 +/** @var kevent::fflags
1.107 +filter flag value
1.108 +*/
1.109 +
1.110 +/** @var kevent::data
1.111 +filter data value
1.112 +*/
1.113 +
1.114 +/** @var kevent::udata
1.115 +opaque user data identifier
1.116 +*/
1.117 +
1.118 +
1.119 +/** @def EV_SET(kevp_, a, b, c, d, e, f)
1.120 +
1.121 +The EV_SET() macro is provided for ease of initializing a kevent structure.
1.122 +
1.123 +@publishedAll
1.124 +@externallyDefinedApi
1.125 +*/
1.126 +
1.127 +
1.128 +/** @def EV_ADD
1.129 +
1.130 +It is an action.. add event to kq (implies enable).
1.131 +
1.132 +@publishedAll
1.133 +@externallyDefinedApi
1.134 +*/
1.135 +
1.136 +/** @def EV_DELETE
1.137 +
1.138 +It is an action.. delete event from kq
1.139 +
1.140 +@publishedAll
1.141 +@externallyDefinedApi
1.142 +*/
1.143 +
1.144 +
1.145 +/** @def EV_ENABLE
1.146 +
1.147 +It is an action.. enable event.
1.148 +
1.149 +@publishedAll
1.150 +@externallyDefinedApi
1.151 +*/
1.152 +
1.153 +
1.154 +/** @def EV_DISABLE
1.155 +
1.156 +It is an action.. disable event (not reported)
1.157 +
1.158 +@publishedAll
1.159 +@externallyDefinedApi
1.160 +*/
1.161 +
1.162 +
1.163 +/** @def EV_ONESHOT
1.164 +
1.165 +flags supported. only report one occurrence.
1.166 +
1.167 +@publishedAll
1.168 +@externallyDefinedApi
1.169 +*/
1.170 +
1.171 +/** @def EV_CLEAR
1.172 +
1.173 +flags supported. clear event state after reporting .
1.174 +
1.175 +@publishedAll
1.176 +@externallyDefinedApi
1.177 +*/
1.178 +
1.179 +
1.180 +/** @def EV_EOF
1.181 +
1.182 +returned value.EOF detected.
1.183 +
1.184 +@publishedAll
1.185 +@externallyDefinedApi
1.186 +*/
1.187 +
1.188 +/** @def EV_ERROR
1.189 +
1.190 +returned value. error, data contains errno.
1.191 +
1.192 +@publishedAll
1.193 +@externallyDefinedApi
1.194 +*/
1.195 +
1.196 +
1.197 +/** @def EV_SYSFLAGS
1.198 +
1.199 +flags supported. reserved by system.
1.200 +
1.201 +@publishedAll
1.202 +@released
1.203 +*/
1.204 +
1.205 +
1.206 +/** @def EV_FLAG1
1.207 +
1.208 +flags supported. filter-specific flag.
1.209 +
1.210 +@publishedAll
1.211 +@released
1.212 +*/
1.213 +
1.214 +
1.215 +/** @struct knote
1.216 +@publishedAll
1.217 +@externallyDefinedApi
1.218 +*/
1.219 +
1.220 +/** @var knote::kn_link
1.221 +for kq
1.222 +*/
1.223 +
1.224 +/** @var knote::kn_selnext
1.225 +for struct selinfo
1.226 +*/
1.227 +
1.228 +/** @var knote::kn_knlist
1.229 +f_attach populated
1.230 +*/
1.231 +
1.232 +/** @var knote::kn_tqe
1.233 +identifier for this event
1.234 +*/
1.235 +
1.236 +/** @var knote::kn_kq
1.237 +which queue we are on
1.238 +*/
1.239 +
1.240 +/** @var knote::kn_kevent
1.241 +identifier for this event
1.242 +*/
1.243 +
1.244 +/** @var knote::kn_status
1.245 +protected by kq lock
1.246 +*/
1.247 +
1.248 +/** @var knote::kn_sfflags
1.249 +saved filter flags
1.250 +*/
1.251 +
1.252 +/** @var knote::kn_sdata
1.253 +saved data field
1.254 +*/
1.255 +
1.256 +/** @var knote::kn_fop
1.257 +identifier for this event
1.258 +*/
1.259 +
1.260 +/** @var knote::kn_hook
1.261 +identifier for this event
1.262 +*/
1.263 +
1.264 +/** @def NOTE_LOWAT
1.265 +@publishedAll
1.266 +@externallyDefinedApi
1.267 +*/
1.268 +
1.269 +
1.270 +/** @def NOTE_DELETE
1.271 +@publishedAll
1.272 +@externallyDefinedApi
1.273 +*/
1.274 +
1.275 +
1.276 +/** @def NOTE_WRITE
1.277 +@publishedAll
1.278 +@externallyDefinedApi
1.279 +*/
1.280 +
1.281 +/** @def NOTE_EXTEND
1.282 +@publishedAll
1.283 +@externallyDefinedApi
1.284 +*/
1.285 +
1.286 +
1.287 +/** @def NOTE_ATTRIB
1.288 +@publishedAll
1.289 +@externallyDefinedApi
1.290 +*/
1.291 +
1.292 +
1.293 +/** @def NOTE_LINK
1.294 +@publishedAll
1.295 +@externallyDefinedApi
1.296 +*/
1.297 +
1.298 +
1.299 +/** @def NOTE_RENAME
1.300 +@publishedAll
1.301 +@externallyDefinedApi
1.302 +*/
1.303 +
1.304 +/** @def NOTE_REVOKE
1.305 +@publishedAll
1.306 +@externallyDefinedApi
1.307 +*/
1.308 +
1.309 +
1.310 +/** @def NOTE_EXIT
1.311 +@publishedAll
1.312 +@externallyDefinedApi
1.313 +*/
1.314 +
1.315 +
1.316 +/** @def NOTE_FORK
1.317 +@publishedAll
1.318 +@externallyDefinedApi
1.319 +*/
1.320 +
1.321 +
1.322 +/** @def NOTE_EXEC
1.323 +@publishedAll
1.324 +@externallyDefinedApi
1.325 +*/
1.326 +
1.327 +
1.328 +/** @def NOTE_TRACK
1.329 +@publishedAll
1.330 +@externallyDefinedApi
1.331 +*/
1.332 +
1.333 +/** @def NOTE_TRACKERR
1.334 +@publishedAll
1.335 +@externallyDefinedApi
1.336 +*/
1.337 +
1.338 +/** @def NOTE_CHILD
1.339 +@publishedAll
1.340 +@externallyDefinedApi
1.341 +*/
1.342 +
1.343 +
1.344 +/** @def NOTE_PCTRLMASK
1.345 +@publishedAll
1.346 +@released
1.347 +*/
1.348 +
1.349 +/** @def NOTE_PDATAMASK
1.350 +@publishedAll
1.351 +@released
1.352 +*/
1.353 +
1.354 +
1.355 +/** @def NOTE_LINKUP
1.356 +@publishedAll
1.357 +@externallyDefinedApi
1.358 +*/
1.359 +
1.360 +
1.361 +/** @def NOTE_LINKDOWN
1.362 +@publishedAll
1.363 +@externallyDefinedApi
1.364 +*/
1.365 +
1.366 +
1.367 +/** @def NOTE_LINKINV
1.368 +@publishedAll
1.369 +@externallyDefinedApi
1.370 +*/
1.371 +
1.372 +
1.373 +