genericopenlibs/openenvcore/include/sys/event.dosc
changeset 0 e4d67989cc36
equal deleted inserted replaced
-1:000000000000 0:e4d67989cc36
       
     1 /** @file  ../include/sys/event.h
       
     2 @internalComponent
       
     3 */
       
     4 
       
     5 /** @def	EVFILT_READ
       
     6 
       
     7 They are some pre-defined system filter
       
     8 
       
     9 @publishedAll
       
    10 @externallyDefinedApi
       
    11 */
       
    12 
       
    13 
       
    14 /** @def	EVFILT_WRITE
       
    15 
       
    16 They are some pre-defined system filter
       
    17 
       
    18 @publishedAll
       
    19 @externallyDefinedApi
       
    20 */
       
    21 
       
    22 /** @def	EVFILT_AIO
       
    23 
       
    24 attached to aio requests
       
    25 
       
    26 @publishedAll
       
    27 @released
       
    28 */
       
    29 
       
    30 
       
    31 
       
    32 /** @def	EVFILT_VNODE
       
    33 
       
    34 attached to vnodes
       
    35 
       
    36 @publishedAll
       
    37 @externallyDefinedApi
       
    38 */
       
    39 
       
    40 
       
    41 /** @def	EVFILT_PROC
       
    42 
       
    43 attached to struct proc
       
    44 
       
    45 @publishedAll
       
    46 @externallyDefinedApi
       
    47 */
       
    48 
       
    49 
       
    50 /** @def	EVFILT_SIGNAL
       
    51 
       
    52 attached to struct proc
       
    53 
       
    54 @publishedAll
       
    55 @externallyDefinedApi
       
    56 */
       
    57 
       
    58 /** @def	EVFILT_TIMER
       
    59 
       
    60 timers
       
    61 
       
    62 @publishedAll
       
    63 @externallyDefinedApi
       
    64 */
       
    65 
       
    66 
       
    67 /** @def	EVFILT_NETDEV
       
    68 
       
    69 network devices
       
    70 
       
    71 @publishedAll
       
    72 @externallyDefinedApi
       
    73 */
       
    74 
       
    75 /** @def	EVFILT_FS
       
    76 
       
    77 filesystem events
       
    78 
       
    79 @publishedAll
       
    80 @released
       
    81 */
       
    82 
       
    83 /** @struct kevent
       
    84 
       
    85 Contains the following members,
       
    86 
       
    87 @publishedAll
       
    88 @externallyDefinedApi
       
    89 */
       
    90 
       
    91 /** @var kevent::ident
       
    92 identifier for this event
       
    93 */
       
    94 
       
    95 /** @var kevent::filter
       
    96 filter for event
       
    97 */
       
    98 
       
    99 /** @var kevent::flags
       
   100 action flags for kqueue
       
   101 */
       
   102 
       
   103 /** @var kevent::fflags
       
   104 filter flag value 
       
   105 */
       
   106 
       
   107 /** @var kevent::data
       
   108 filter data value
       
   109 */
       
   110 
       
   111 /** @var kevent::udata
       
   112 opaque user data identifier
       
   113 */
       
   114 
       
   115 
       
   116 /** @def EV_SET(kevp_, a, b, c, d, e, f)
       
   117 
       
   118 The EV_SET() macro is provided for ease of initializing a kevent structure. 
       
   119 
       
   120 @publishedAll
       
   121 @externallyDefinedApi
       
   122 */
       
   123 
       
   124 
       
   125 /** @def EV_ADD		
       
   126 
       
   127 It is an action.. add event to kq (implies enable).
       
   128 
       
   129 @publishedAll
       
   130 @externallyDefinedApi
       
   131 */
       
   132 
       
   133 /** @def EV_DELETE
       
   134 
       
   135 It is an action.. delete event from kq
       
   136 	
       
   137 @publishedAll
       
   138 @externallyDefinedApi
       
   139 */
       
   140 
       
   141 
       
   142 /** @def EV_ENABLE
       
   143 
       
   144 It is an action.. enable event.
       
   145 	
       
   146 @publishedAll
       
   147 @externallyDefinedApi
       
   148 */
       
   149 
       
   150 
       
   151 /** @def EV_DISABLE	
       
   152 
       
   153 It is an action.. disable event (not reported)
       
   154 
       
   155 @publishedAll
       
   156 @externallyDefinedApi
       
   157 */
       
   158 
       
   159 
       
   160 /** @def EV_ONESHOT	
       
   161 
       
   162 flags supported. only report one occurrence.
       
   163 
       
   164 @publishedAll
       
   165 @externallyDefinedApi
       
   166 */
       
   167 
       
   168 /** @def EV_CLEAR
       
   169 	
       
   170 flags supported. clear event state after reporting .
       
   171 
       
   172 @publishedAll
       
   173 @externallyDefinedApi
       
   174 */
       
   175 
       
   176 
       
   177 /** @def EV_EOF		
       
   178 
       
   179 returned value.EOF detected.
       
   180 
       
   181 @publishedAll
       
   182 @externallyDefinedApi
       
   183 */
       
   184 
       
   185 /** @def EV_ERROR	
       
   186 
       
   187 returned value. error, data contains errno.
       
   188 
       
   189 @publishedAll
       
   190 @externallyDefinedApi
       
   191 */
       
   192 
       
   193 
       
   194 /** @def EV_SYSFLAGS	
       
   195 
       
   196 flags supported. reserved by system.
       
   197 
       
   198 @publishedAll
       
   199 @released
       
   200 */
       
   201 
       
   202 
       
   203 /** @def EV_FLAG1	
       
   204 
       
   205 flags supported. filter-specific flag.
       
   206 
       
   207 @publishedAll
       
   208 @released
       
   209 */
       
   210 
       
   211 
       
   212 /** @struct knote 
       
   213 @publishedAll
       
   214 @externallyDefinedApi
       
   215 */
       
   216 
       
   217 /** @var knote::kn_link
       
   218 for kq
       
   219 */
       
   220 
       
   221 /** @var knote::kn_selnext
       
   222 for struct selinfo
       
   223 */
       
   224 
       
   225 /** @var knote::kn_knlist
       
   226 f_attach populated
       
   227 */
       
   228 
       
   229 /** @var knote::kn_tqe
       
   230 identifier for this event
       
   231 */
       
   232 
       
   233 /** @var knote::kn_kq
       
   234 which queue we are on 
       
   235 */
       
   236 
       
   237 /** @var knote::kn_kevent
       
   238 identifier for this event
       
   239 */
       
   240 
       
   241 /** @var knote::kn_status
       
   242 protected by kq lock
       
   243 */
       
   244 
       
   245 /** @var knote::kn_sfflags
       
   246 saved filter flags
       
   247 */
       
   248 
       
   249 /** @var knote::kn_sdata
       
   250 saved data field 
       
   251 */
       
   252 
       
   253 /** @var knote::kn_fop
       
   254 identifier for this event
       
   255 */
       
   256 
       
   257 /** @var knote::kn_hook
       
   258 identifier for this event
       
   259 */
       
   260 
       
   261 /** @def NOTE_LOWAT	
       
   262 @publishedAll
       
   263 @externallyDefinedApi
       
   264 */
       
   265 
       
   266 
       
   267 /** @def NOTE_DELETE	
       
   268 @publishedAll
       
   269 @externallyDefinedApi
       
   270 */
       
   271 
       
   272 
       
   273 /** @def NOTE_WRITE	
       
   274 @publishedAll
       
   275 @externallyDefinedApi
       
   276 */
       
   277 
       
   278 /** @def NOTE_EXTEND	
       
   279 @publishedAll
       
   280 @externallyDefinedApi
       
   281 */
       
   282 
       
   283 
       
   284 /** @def NOTE_ATTRIB	
       
   285 @publishedAll
       
   286 @externallyDefinedApi
       
   287 */
       
   288 
       
   289 
       
   290 /** @def NOTE_LINK	
       
   291 @publishedAll
       
   292 @externallyDefinedApi
       
   293 */
       
   294 
       
   295 
       
   296 /** @def NOTE_RENAME	
       
   297 @publishedAll
       
   298 @externallyDefinedApi
       
   299 */
       
   300 
       
   301 /** @def NOTE_REVOKE	
       
   302 @publishedAll
       
   303 @externallyDefinedApi
       
   304 */
       
   305 
       
   306 
       
   307 /** @def NOTE_EXIT	
       
   308 @publishedAll
       
   309 @externallyDefinedApi
       
   310 */
       
   311 
       
   312 
       
   313 /** @def NOTE_FORK	
       
   314 @publishedAll
       
   315 @externallyDefinedApi
       
   316 */
       
   317 
       
   318 
       
   319 /** @def NOTE_EXEC	
       
   320 @publishedAll
       
   321 @externallyDefinedApi
       
   322 */
       
   323 
       
   324 
       
   325 /** @def NOTE_TRACK	
       
   326 @publishedAll
       
   327 @externallyDefinedApi
       
   328 */
       
   329 
       
   330 /** @def NOTE_TRACKERR	
       
   331 @publishedAll
       
   332 @externallyDefinedApi
       
   333 */
       
   334 
       
   335 /** @def NOTE_CHILD	
       
   336 @publishedAll
       
   337 @externallyDefinedApi
       
   338 */
       
   339 
       
   340 
       
   341 /** @def NOTE_PCTRLMASK	
       
   342 @publishedAll
       
   343 @released
       
   344 */
       
   345 
       
   346 /** @def NOTE_PDATAMASK	
       
   347 @publishedAll
       
   348 @released
       
   349 */
       
   350 
       
   351 
       
   352 /** @def NOTE_LINKUP	
       
   353 @publishedAll
       
   354 @externallyDefinedApi
       
   355 */
       
   356 
       
   357 
       
   358 /** @def NOTE_LINKDOWN	
       
   359 @publishedAll
       
   360 @externallyDefinedApi
       
   361 */
       
   362 
       
   363 
       
   364 /** @def NOTE_LINKINV	
       
   365 @publishedAll
       
   366 @externallyDefinedApi
       
   367 */
       
   368 
       
   369 
       
   370