1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/genericopenlibs/openenvcore/include/signal.dosc Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,455 @@
1.4 +/** @file ../include/signal.h
1.5 +@internalComponent
1.6 +*/
1.7 +
1.8 +/** @fn sigaction(int sig, const struct sigaction *act, struct sigaction *oact)
1.9 +@param sig -
1.10 +@param act -
1.11 +@param oact -
1.12 +
1.13 +@return -
1.14 +
1.15 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigaction.html
1.16 +
1.17 +The Symbian version of the sigaction() function has the following limitations:
1.18 +
1.19 +1. The sa_mask member of the sigaction structure is ignored.
1.20 +
1.21 +2. Currently, only the SA_SIGINFO flag will be supported in the sa_flags member of the sigaction structure.
1.22 +
1.23 +3. Only the following portions of the signal catching function specified in sa_sigaction member will be supported:
1.24 +
1.25 +a. The first argument (signo)
1.26 +
1.27 +b. si_signo and si_value members of the second argument (info)
1.28 +
1.29 +@publishedAll
1.30 +@externallyDefinedApi
1.31 +*/
1.32 +
1.33 +/** @fn sigemptyset(sigset_t* set)
1.34 +@param set -
1.35 +@return -
1.36 +
1.37 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigemptyset.html
1.38 +
1.39 +The Symbian implementation of this API fully supports POSIX functionality.
1.40 +
1.41 +@publishedAll
1.42 +@externallyDefinedApi
1.43 +*/
1.44 +
1.45 +/** @def SIG_UNBLOCK
1.46 +
1.47 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
1.48 +
1.49 +@publishedAll
1.50 +@externallyDefinedApi
1.51 +*/
1.52 +
1.53 +/** @def SIG_SETMASK
1.54 +
1.55 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
1.56 +
1.57 +@publishedAll
1.58 +@externallyDefinedApi
1.59 +*/
1.60 +
1.61 +/** @def SIG_BLOCK
1.62 +
1.63 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
1.64 +
1.65 +@publishedAll
1.66 +@externallyDefinedApi
1.67 +*/
1.68 +
1.69 +/** @def SIG_DFL
1.70 +
1.71 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
1.72 +
1.73 +@publishedAll
1.74 +@externallyDefinedApi
1.75 +*/
1.76 +
1.77 +/** @def SIG_ERR
1.78 +
1.79 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
1.80 +
1.81 +@publishedAll
1.82 +@externallyDefinedApi
1.83 +*/
1.84 +
1.85 +/** @def SIG_HOLD
1.86 +
1.87 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
1.88 +
1.89 +@publishedAll
1.90 +@externallyDefinedApi
1.91 +*/
1.92 +
1.93 +/** @def SA_SIGINFO
1.94 +
1.95 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
1.96 +
1.97 +@publishedAll
1.98 +@externallyDefinedApi
1.99 +*/
1.100 +
1.101 +/** @struct sigaction
1.102 +
1.103 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
1.104 +
1.105 +@publishedAll
1.106 +@externallyDefinedApi
1.107 +*/
1.108 +
1.109 +/** @typedef sigset_t
1.110 +
1.111 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
1.112 +
1.113 +@publishedAll
1.114 +@externallyDefinedApi
1.115 +*/
1.116 +
1.117 +#ifdef SYMBIAN_OE_POSIX_SIGNALS
1.118 +/** @fn kill(pid_t pid, int sig)
1.119 +@param pid -
1.120 +@param sig -
1.121 +@return -
1.122 +
1.123 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/kill.html
1.124 +
1.125 +The Symbian version of the sigaction() function has the following limitations:
1.126 +
1.127 +1. Handling of pid values less than or equal to 0 is not supported.
1.128 +
1.129 +2. PowerManagement capability is required to send SIGKILL/SIGSTOP to another process.
1.130 +
1.131 +@publishedAll
1.132 +@externallyDefinedApi
1.133 +*/
1.134 +
1.135 +/** @fn raise(int sig)
1.136 +@param sig -
1.137 +@return -
1.138 +
1.139 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/raise.html
1.140 +
1.141 +The Symbian implementation of this API fully supports POSIX functionality.
1.142 +
1.143 +@publishedAll
1.144 +@externallyDefinedApi
1.145 +*/
1.146 +
1.147 +/** @fn sigqueue(pid_t pid, int sig, const union sigval value)
1.148 +@param pid -
1.149 +@param sig -
1.150 +@param value -
1.151 +@return -
1.152 +
1.153 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigqueue.html
1.154 +
1.155 +The Symbian version of the sigaction() function has the following limitation:
1.156 +
1.157 +1. PowerManagement capability is required to send SIGKILL/SIGSTOP to another process.
1.158 +
1.159 +@publishedAll
1.160 +@externallyDefinedApi
1.161 +*/
1.162 +
1.163 +/** @fn sigfillset(sigset_t *set)
1.164 +@param set -
1.165 +@return -
1.166 +
1.167 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigfillset.html
1.168 +
1.169 +The Symbian implementation of this API fully supports POSIX functionality.
1.170 +
1.171 +@publishedAll
1.172 +@externallyDefinedApi
1.173 +*/
1.174 +
1.175 +/** @fn sigaddset(sigset_t *set, int signo)
1.176 +@param set -
1.177 +@param signo -
1.178 +@return -
1.179 +
1.180 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigaddset.html
1.181 +
1.182 +The Symbian implementation of this API fully supports POSIX functionality.
1.183 +
1.184 +@publishedAll
1.185 +@externallyDefinedApi
1.186 +*/
1.187 +
1.188 +/** @fn sigdelset(sigset_t *set, int signo)
1.189 +@param set -
1.190 +@param signo -
1.191 +@return -
1.192 +
1.193 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigdelset.html
1.194 +
1.195 +The Symbian implementation of this API fully supports POSIX functionality.
1.196 +
1.197 +@publishedAll
1.198 +@externallyDefinedApi
1.199 +*/
1.200 +
1.201 +/** @fn sigismember(const sigset_t *set, int signo)
1.202 +@param set -
1.203 +@param signo -
1.204 +@return -
1.205 +
1.206 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigismember.html
1.207 +
1.208 +The Symbian implementation of this API fully supports POSIX functionality.
1.209 +
1.210 +@publishedAll
1.211 +@externallyDefinedApi
1.212 +*/
1.213 +
1.214 +/** @fn sigandset(sigset_t * set, const sigset_t * left, const sigset_t * right)
1.215 +@param set -
1.216 +@param left -
1.217 +@param right -
1.218 +@return -
1.219 +
1.220 +For full documentation see: http://refspecs.freestandards.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/baselib-sigandset.html
1.221 +
1.222 +The Symbian implementation of this API fully supports POSIX functionality.
1.223 +
1.224 +@publishedAll
1.225 +@externallyDefinedApi
1.226 +*/
1.227 +
1.228 +/** @fn sigorset(sigset_t * set, const sigset_t * left, const sigset_t * right)
1.229 +@param set -
1.230 +@param left -
1.231 +@param right -
1.232 +@return -
1.233 +
1.234 +For full documentation see: http://refspecs.freestandards.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/baselib-sigorset.html
1.235 +
1.236 +The Symbian implementation of this API fully supports POSIX functionality.
1.237 +
1.238 +@publishedAll
1.239 +@externallyDefinedApi
1.240 +*/
1.241 +
1.242 +/** @fn sigisemptyset(const sigset_t * set)
1.243 +@param set -
1.244 +@return -
1.245 +
1.246 +For full documentation see: http://refspecs.freestandards.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/baselib-sigisemptyset.html
1.247 +
1.248 +The Symbian implementation of this API fully supports POSIX functionality.
1.249 +
1.250 +@publishedAll
1.251 +@externallyDefinedApi
1.252 +*/
1.253 +
1.254 +/** @fn sigprocmask(int how, const sigset_t* set,sigset_t* oset)
1.255 +@param how -
1.256 +@param set -
1.257 +@param oset -
1.258 +@return -
1.259 +
1.260 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigprocmask.html
1.261 +
1.262 +The Symbian implementation of this API fully supports POSIX functionality.
1.263 +
1.264 +@publishedAll
1.265 +@externallyDefinedApi
1.266 +*/
1.267 +
1.268 +/** @fn sighold(int signo)
1.269 +@param signo -
1.270 +@return -
1.271 +
1.272 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sighold.html
1.273 +
1.274 +The Symbian implementation of this API fully supports POSIX functionality.
1.275 +
1.276 +@publishedAll
1.277 +@externallyDefinedApi
1.278 +*/
1.279 +
1.280 +/** @fn sigrelse(int signo)
1.281 +@param signo -
1.282 +@return -
1.283 +
1.284 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigrelse.html
1.285 +
1.286 +The Symbian implementation of this API fully supports POSIX functionality.
1.287 +
1.288 +@publishedAll
1.289 +@externallyDefinedApi
1.290 +*/
1.291 +
1.292 +/** @fn sigpause(int signo)
1.293 +@param signo -
1.294 +@return -
1.295 +
1.296 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigpause.html
1.297 +
1.298 +The Symbian implementation of this API fully supports POSIX functionality.
1.299 +
1.300 +@publishedAll
1.301 +@externallyDefinedApi
1.302 +*/
1.303 +
1.304 +/** @fn sigwait(const sigset_t *set, int *sig)
1.305 +@param set -
1.306 +@param sig -
1.307 +@return -
1.308 +
1.309 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigwait.html
1.310 +
1.311 +The Symbian implementation of this API fully supports POSIX functionality.
1.312 +
1.313 +@publishedAll
1.314 +@externallyDefinedApi
1.315 +*/
1.316 +
1.317 +/** @fn sigtimedwait(const sigset_t *set, siginfo_t *info,
1.318 + const struct timespec *timeout)
1.319 +@param set -
1.320 +@param info -
1.321 +@param timeout -
1.322 +@return -
1.323 +
1.324 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigtimedwait.html
1.325 +
1.326 +The Symbian implementation of this API fully supports POSIX functionality.
1.327 +
1.328 +@publishedAll
1.329 +@externallyDefinedApi
1.330 +*/
1.331 +
1.332 +/** @fn sigwaitinfo(const sigset_t *set, siginfo_t *info)
1.333 +@param set -
1.334 +@param info -
1.335 +@return -
1.336 +
1.337 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigwaitinfo.html
1.338 +
1.339 +The Symbian implementation of this API fully supports POSIX functionality.
1.340 +
1.341 +@publishedAll
1.342 +@externallyDefinedApi
1.343 +*/
1.344 +
1.345 +/** @fn bsd_signal(int, void (*)(int))
1.346 +
1.347 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/bsd_signal.html
1.348 +
1.349 +The Symbian implementation of this API fully supports POSIX functionality.
1.350 +
1.351 +@publishedAll
1.352 +@externallyDefinedApi
1.353 +*/
1.354 +
1.355 +/** @fn sigset(int, void (*)(int))
1.356 +
1.357 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigset.html
1.358 +
1.359 +The Symbian implementation of this API fully supports POSIX functionality.
1.360 +
1.361 +@publishedAll
1.362 +@externallyDefinedApi
1.363 +*/
1.364 +
1.365 +/** @fn signal(int, void (*)(int))
1.366 +
1.367 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/signal.html
1.368 +
1.369 +The Symbian implementation of this API fully supports POSIX functionality.
1.370 +
1.371 +@publishedAll
1.372 +@externallyDefinedApi
1.373 +*/
1.374 +
1.375 +/** @fn sigpending(sigset_t *set)
1.376 +@param set -
1.377 +@return -
1.378 +
1.379 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigpending.html
1.380 +
1.381 +The Symbian implementation of this API fully supports POSIX functionality.
1.382 +
1.383 +@publishedAll
1.384 +@externallyDefinedApi
1.385 +*/
1.386 +
1.387 +/** @fn sigignore(int sig)
1.388 +@param sig -
1.389 +@return -
1.390 +
1.391 +For full documentation see: http://www.opengroup.org/onlinepubs/009695399/functions/sigignore.html
1.392 +
1.393 +The Symbian implementation of this API fully supports POSIX functionality.
1.394 +
1.395 +@publishedAll
1.396 +@externallyDefinedApi
1.397 +*/
1.398 +
1.399 +/** @fn psignal(int sig, const char *s)
1.400 +@param sig -
1.401 +@param s -
1.402 +@return -
1.403 +
1.404 +For full documentation see: http://refspecs.linux-foundation.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/baselib-psignal-3.html
1.405 +
1.406 +The Symbian implementation of this API fully supports POSIX functionality.
1.407 +
1.408 +@publishedAll
1.409 +@externallyDefinedApi
1.410 +*/
1.411 +/** @struct sigevent
1.412 +
1.413 +For full documentation of struct sigevent see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
1.414 +
1.415 +@publishedAll
1.416 +@externallyDefinedApi
1.417 +*/
1.418 +
1.419 +/** @var sigevent::sigev_value
1.420 +*/
1.421 +
1.422 +/** @var sigevent::sigev_signo
1.423 +*/
1.424 +
1.425 +/** @var sigevent::sigev_notify
1.426 +*/
1.427 +
1.428 +/** @var sigevent::sigev_notify_function
1.429 +*/
1.430 +
1.431 +/** @var sigevent::sigev_notify_attributes
1.432 +*/
1.433 +
1.434 +/** @def SIGEV_SIGNAL
1.435 +
1.436 +For full documentation of SIGEV_SIGNAL see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
1.437 +
1.438 +@publishedAll
1.439 +@externallyDefinedApi
1.440 +*/
1.441 +
1.442 +/** @def SIGEV_NONE
1.443 +
1.444 +For full documentation of SIGEV_NONE see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
1.445 +
1.446 +@publishedAll
1.447 +@externallyDefinedApi
1.448 +*/
1.449 +
1.450 +/** @def SIGEV_THREAD
1.451 +
1.452 +For full documentation of SIGEV_THREAD see: http://www.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html
1.453 +
1.454 +@publishedAll
1.455 +@externallyDefinedApi
1.456 +*/
1.457 +#endif
1.458 +