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