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