os/ossrv/genericopenlibs/openenvcore/include/signal.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/signal.h
sl@0
     2
@internalComponent
sl@0
     3
*/
sl@0
     4
sl@0
     5
/** @fn  sigaction(int sig, const struct sigaction *act, struct sigaction *oact)
sl@0
     6
@param sig -
sl@0
     7
@param act -
sl@0
     8
@param oact -
sl@0
     9
sl@0
    10
@return  -
sl@0
    11
sl@0
    12
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigaction.html
sl@0
    13
sl@0
    14
The Symbian version of the sigaction() function has the following limitations:
sl@0
    15
sl@0
    16
1.	The sa_mask member of the sigaction structure is ignored.
sl@0
    17
sl@0
    18
2.	Currently, only the SA_SIGINFO flag will be supported in the sa_flags member of the sigaction structure.
sl@0
    19
sl@0
    20
3.	Only the following portions of the signal catching function specified in sa_sigaction member will be supported:
sl@0
    21
sl@0
    22
a. The first argument (signo)
sl@0
    23
sl@0
    24
b. si_signo and si_value members of the second argument (info)
sl@0
    25
sl@0
    26
@publishedAll
sl@0
    27
@externallyDefinedApi
sl@0
    28
*/
sl@0
    29
sl@0
    30
/** @fn  sigemptyset(sigset_t* set)
sl@0
    31
@param set -
sl@0
    32
@return  -
sl@0
    33
sl@0
    34
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigemptyset.html
sl@0
    35
sl@0
    36
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
    37
sl@0
    38
@publishedAll
sl@0
    39
@externallyDefinedApi
sl@0
    40
*/
sl@0
    41
sl@0
    42
/** @def  SIG_UNBLOCK
sl@0
    43
sl@0
    44
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
sl@0
    45
sl@0
    46
@publishedAll
sl@0
    47
@externallyDefinedApi
sl@0
    48
*/
sl@0
    49
sl@0
    50
/** @def  SIG_SETMASK
sl@0
    51
sl@0
    52
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
sl@0
    53
sl@0
    54
@publishedAll
sl@0
    55
@externallyDefinedApi
sl@0
    56
*/
sl@0
    57
sl@0
    58
/** @def  SIG_BLOCK
sl@0
    59
sl@0
    60
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
sl@0
    61
sl@0
    62
@publishedAll
sl@0
    63
@externallyDefinedApi
sl@0
    64
*/
sl@0
    65
sl@0
    66
/** @def  SIG_DFL
sl@0
    67
sl@0
    68
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
sl@0
    69
sl@0
    70
@publishedAll
sl@0
    71
@externallyDefinedApi
sl@0
    72
*/
sl@0
    73
sl@0
    74
/** @def  SIG_ERR
sl@0
    75
sl@0
    76
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
sl@0
    77
sl@0
    78
@publishedAll
sl@0
    79
@externallyDefinedApi
sl@0
    80
*/
sl@0
    81
sl@0
    82
/** @def  SIG_HOLD
sl@0
    83
sl@0
    84
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
sl@0
    85
sl@0
    86
@publishedAll
sl@0
    87
@externallyDefinedApi
sl@0
    88
*/
sl@0
    89
sl@0
    90
/** @def  SA_SIGINFO
sl@0
    91
sl@0
    92
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
sl@0
    93
sl@0
    94
@publishedAll
sl@0
    95
@externallyDefinedApi
sl@0
    96
*/
sl@0
    97
sl@0
    98
/** @struct sigaction
sl@0
    99
sl@0
   100
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
sl@0
   101
sl@0
   102
@publishedAll
sl@0
   103
@externallyDefinedApi
sl@0
   104
*/
sl@0
   105
sl@0
   106
/** @typedef sigset_t
sl@0
   107
sl@0
   108
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
sl@0
   109
sl@0
   110
@publishedAll
sl@0
   111
@externallyDefinedApi
sl@0
   112
*/
sl@0
   113
sl@0
   114
#ifdef SYMBIAN_OE_POSIX_SIGNALS
sl@0
   115
/** @fn  kill(pid_t pid, int sig)
sl@0
   116
@param pid -
sl@0
   117
@param sig -
sl@0
   118
@return  -
sl@0
   119
sl@0
   120
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/kill.html
sl@0
   121
sl@0
   122
The Symbian version of the sigaction() function has the following limitations:
sl@0
   123
sl@0
   124
1.	Handling of pid values less than or equal to 0 is not supported.
sl@0
   125
sl@0
   126
2.	PowerManagement capability is required to send SIGKILL/SIGSTOP to another process.
sl@0
   127
sl@0
   128
@publishedAll
sl@0
   129
@externallyDefinedApi
sl@0
   130
*/
sl@0
   131
sl@0
   132
/** @fn  raise(int sig)
sl@0
   133
@param sig -
sl@0
   134
@return  -
sl@0
   135
sl@0
   136
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/raise.html
sl@0
   137
sl@0
   138
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   139
sl@0
   140
@publishedAll
sl@0
   141
@externallyDefinedApi
sl@0
   142
*/
sl@0
   143
sl@0
   144
/** @fn  sigqueue(pid_t pid, int sig, const union sigval value)
sl@0
   145
@param pid -
sl@0
   146
@param sig -
sl@0
   147
@param value -
sl@0
   148
@return  -
sl@0
   149
sl@0
   150
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigqueue.html
sl@0
   151
sl@0
   152
The Symbian version of the sigaction() function has the following limitation:
sl@0
   153
sl@0
   154
1.	PowerManagement capability is required to send SIGKILL/SIGSTOP to another process.
sl@0
   155
sl@0
   156
@publishedAll
sl@0
   157
@externallyDefinedApi
sl@0
   158
*/
sl@0
   159
sl@0
   160
/** @fn  sigfillset(sigset_t *set)
sl@0
   161
@param set -
sl@0
   162
@return  -
sl@0
   163
sl@0
   164
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigfillset.html
sl@0
   165
sl@0
   166
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   167
sl@0
   168
@publishedAll
sl@0
   169
@externallyDefinedApi
sl@0
   170
*/
sl@0
   171
sl@0
   172
/** @fn  sigaddset(sigset_t *set, int signo)
sl@0
   173
@param set -
sl@0
   174
@param signo -
sl@0
   175
@return  -
sl@0
   176
sl@0
   177
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigaddset.html
sl@0
   178
sl@0
   179
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   180
sl@0
   181
@publishedAll
sl@0
   182
@externallyDefinedApi
sl@0
   183
*/
sl@0
   184
sl@0
   185
/** @fn  sigdelset(sigset_t *set, int signo)
sl@0
   186
@param set -
sl@0
   187
@param signo -
sl@0
   188
@return  -
sl@0
   189
sl@0
   190
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigdelset.html
sl@0
   191
sl@0
   192
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   193
sl@0
   194
@publishedAll
sl@0
   195
@externallyDefinedApi
sl@0
   196
*/
sl@0
   197
sl@0
   198
/** @fn  sigismember(const sigset_t *set, int signo)
sl@0
   199
@param set -
sl@0
   200
@param signo -
sl@0
   201
@return  -
sl@0
   202
sl@0
   203
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigismember.html
sl@0
   204
sl@0
   205
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   206
sl@0
   207
@publishedAll
sl@0
   208
@externallyDefinedApi
sl@0
   209
*/
sl@0
   210
sl@0
   211
/** @fn  sigandset(sigset_t * set, const sigset_t * left, const sigset_t * right)
sl@0
   212
@param set -
sl@0
   213
@param left -
sl@0
   214
@param right -
sl@0
   215
@return  -
sl@0
   216
sl@0
   217
For full documentation see: http://refspecs.freestandards.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/baselib-sigandset.html
sl@0
   218
sl@0
   219
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   220
sl@0
   221
@publishedAll
sl@0
   222
@externallyDefinedApi
sl@0
   223
*/
sl@0
   224
sl@0
   225
/** @fn  sigorset(sigset_t * set, const sigset_t * left, const sigset_t * right)
sl@0
   226
@param set -
sl@0
   227
@param left -
sl@0
   228
@param right -
sl@0
   229
@return  -
sl@0
   230
sl@0
   231
For full documentation see: http://refspecs.freestandards.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/baselib-sigorset.html
sl@0
   232
sl@0
   233
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   234
sl@0
   235
@publishedAll
sl@0
   236
@externallyDefinedApi
sl@0
   237
*/
sl@0
   238
sl@0
   239
/** @fn  sigisemptyset(const sigset_t * set)
sl@0
   240
@param set -
sl@0
   241
@return  -
sl@0
   242
sl@0
   243
For full documentation see: http://refspecs.freestandards.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/baselib-sigisemptyset.html
sl@0
   244
sl@0
   245
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   246
sl@0
   247
@publishedAll
sl@0
   248
@externallyDefinedApi
sl@0
   249
*/
sl@0
   250
sl@0
   251
/** @fn  sigprocmask(int how, const sigset_t* set,sigset_t* oset)
sl@0
   252
@param how -
sl@0
   253
@param set -
sl@0
   254
@param oset -
sl@0
   255
@return  -
sl@0
   256
sl@0
   257
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigprocmask.html
sl@0
   258
sl@0
   259
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   260
sl@0
   261
@publishedAll
sl@0
   262
@externallyDefinedApi
sl@0
   263
*/
sl@0
   264
sl@0
   265
/** @fn  sighold(int signo)
sl@0
   266
@param signo -
sl@0
   267
@return  -
sl@0
   268
sl@0
   269
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sighold.html
sl@0
   270
sl@0
   271
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   272
sl@0
   273
@publishedAll
sl@0
   274
@externallyDefinedApi
sl@0
   275
*/
sl@0
   276
sl@0
   277
/** @fn  sigrelse(int signo)
sl@0
   278
@param signo -
sl@0
   279
@return  -
sl@0
   280
sl@0
   281
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigrelse.html
sl@0
   282
sl@0
   283
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   284
sl@0
   285
@publishedAll
sl@0
   286
@externallyDefinedApi
sl@0
   287
*/
sl@0
   288
sl@0
   289
/** @fn  sigpause(int signo)
sl@0
   290
@param signo -
sl@0
   291
@return  -
sl@0
   292
sl@0
   293
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigpause.html
sl@0
   294
sl@0
   295
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   296
sl@0
   297
@publishedAll
sl@0
   298
@externallyDefinedApi
sl@0
   299
*/
sl@0
   300
sl@0
   301
/** @fn  sigwait(const sigset_t *set, int *sig)
sl@0
   302
@param set -
sl@0
   303
@param sig -
sl@0
   304
@return  -
sl@0
   305
sl@0
   306
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigwait.html
sl@0
   307
sl@0
   308
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   309
sl@0
   310
@publishedAll
sl@0
   311
@externallyDefinedApi
sl@0
   312
*/
sl@0
   313
sl@0
   314
/** @fn  sigtimedwait(const sigset_t *set, siginfo_t *info,
sl@0
   315
       const struct timespec *timeout)
sl@0
   316
@param set -
sl@0
   317
@param info -
sl@0
   318
@param timeout -
sl@0
   319
@return  -
sl@0
   320
sl@0
   321
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigtimedwait.html
sl@0
   322
sl@0
   323
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   324
sl@0
   325
@publishedAll
sl@0
   326
@externallyDefinedApi
sl@0
   327
*/
sl@0
   328
sl@0
   329
/** @fn  sigwaitinfo(const sigset_t *set, siginfo_t *info)
sl@0
   330
@param set -
sl@0
   331
@param info -
sl@0
   332
@return  -
sl@0
   333
sl@0
   334
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigwaitinfo.html
sl@0
   335
sl@0
   336
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   337
sl@0
   338
@publishedAll
sl@0
   339
@externallyDefinedApi
sl@0
   340
*/
sl@0
   341
sl@0
   342
/** @fn  bsd_signal(int, void (*)(int))
sl@0
   343
sl@0
   344
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/bsd_signal.html
sl@0
   345
sl@0
   346
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   347
sl@0
   348
@publishedAll
sl@0
   349
@externallyDefinedApi
sl@0
   350
*/
sl@0
   351
sl@0
   352
/** @fn  sigset(int, void (*)(int))
sl@0
   353
sl@0
   354
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigset.html
sl@0
   355
sl@0
   356
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   357
sl@0
   358
@publishedAll
sl@0
   359
@externallyDefinedApi
sl@0
   360
*/
sl@0
   361
sl@0
   362
/** @fn  signal(int, void (*)(int))
sl@0
   363
sl@0
   364
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/signal.html
sl@0
   365
sl@0
   366
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   367
sl@0
   368
@publishedAll
sl@0
   369
@externallyDefinedApi
sl@0
   370
*/
sl@0
   371
sl@0
   372
/** @fn  sigpending(sigset_t *set)
sl@0
   373
@param set -
sl@0
   374
@return  -
sl@0
   375
sl@0
   376
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigpending.html
sl@0
   377
sl@0
   378
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   379
sl@0
   380
@publishedAll
sl@0
   381
@externallyDefinedApi
sl@0
   382
*/
sl@0
   383
sl@0
   384
/** @fn  sigignore(int sig)
sl@0
   385
@param sig -
sl@0
   386
@return  -
sl@0
   387
sl@0
   388
For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigignore.html
sl@0
   389
sl@0
   390
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   391
sl@0
   392
@publishedAll
sl@0
   393
@externallyDefinedApi
sl@0
   394
*/
sl@0
   395
sl@0
   396
/** @fn  psignal(int sig, const char *s)
sl@0
   397
@param sig -
sl@0
   398
@param s -
sl@0
   399
@return  -
sl@0
   400
sl@0
   401
For full documentation see: http://refspecs.linux-foundation.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/baselib-psignal-3.html
sl@0
   402
sl@0
   403
The Symbian implementation of this API fully supports POSIX functionality.
sl@0
   404
sl@0
   405
@publishedAll
sl@0
   406
@externallyDefinedApi
sl@0
   407
*/
sl@0
   408
/** @struct sigevent 
sl@0
   409
sl@0
   410
For full documentation of struct sigevent see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
sl@0
   411
sl@0
   412
@publishedAll
sl@0
   413
@externallyDefinedApi
sl@0
   414
*/
sl@0
   415
sl@0
   416
/** @var sigevent::sigev_value
sl@0
   417
*/
sl@0
   418
sl@0
   419
/** @var sigevent::sigev_signo
sl@0
   420
*/
sl@0
   421
sl@0
   422
/** @var sigevent::sigev_notify
sl@0
   423
*/
sl@0
   424
sl@0
   425
/** @var sigevent::sigev_notify_function
sl@0
   426
*/
sl@0
   427
sl@0
   428
/** @var sigevent::sigev_notify_attributes
sl@0
   429
*/
sl@0
   430
sl@0
   431
/** @def SIGEV_SIGNAL
sl@0
   432
sl@0
   433
For full documentation of SIGEV_SIGNAL see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
sl@0
   434
sl@0
   435
@publishedAll
sl@0
   436
@externallyDefinedApi
sl@0
   437
*/
sl@0
   438
sl@0
   439
/** @def SIGEV_NONE
sl@0
   440
sl@0
   441
For full documentation of SIGEV_NONE see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
sl@0
   442
sl@0
   443
@publishedAll
sl@0
   444
@externallyDefinedApi
sl@0
   445
*/
sl@0
   446
sl@0
   447
/** @def SIGEV_THREAD
sl@0
   448
sl@0
   449
For full documentation of SIGEV_THREAD see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
sl@0
   450
sl@0
   451
@publishedAll
sl@0
   452
@externallyDefinedApi
sl@0
   453
*/
sl@0
   454
#endif
sl@0
   455