documentation/api/modules/luci.sys.process.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html>
   4 <head>
   5     <title>Reference</title>
   6     <link rel="stylesheet" href="../luadoc.css" type="text/css" />
   7         <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
   8 </head>
   9
  10 <body>
  11 <div id="container">
  12
  13 <div id="product">
  14         <div id="product_logo"></div>
  15         <div id="product_name"><big><b></b></big></div>
  16         <div id="product_description"></div>
  17 </div> <!-- id="product" -->
  18
  19 <div id="main">
  20
  21 <div id="navigation">
  22
  23
  24 <h1>LuaDoc</h1>
  25 <ul>
  26
  27         <li><a href="../index.html">Index</a></li>
  28
  29 </ul>
  30
  31
  32 <!-- Module list -->
  33
  34 <h1>Modules</h1>
  35 <ul>
  36
  37         <li>
  38                 <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
  39         </li>
  40
  41         <li>
  42                 <a href="../modules/luci.http.html">luci.http</a>
  43         </li>
  44
  45         <li>
  46                 <a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
  47         </li>
  48
  49         <li>
  50                 <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
  51         </li>
  52
  53         <li>
  54                 <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
  55         </li>
  56
  57         <li>
  58                 <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
  59         </li>
  60
  61         <li>
  62                 <a href="../modules/luci.i18n.html">luci.i18n</a>
  63         </li>
  64
  65         <li>
  66                 <a href="../modules/luci.ip.html">luci.ip</a>
  67         </li>
  68
  69         <li>
  70                 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
  71         </li>
  72
  73         <li>
  74                 <a href="../modules/luci.json.html">luci.json</a>
  75         </li>
  76
  77         <li>
  78                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  79         </li>
  80
  81         <li>
  82                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  83         </li>
  84
  85         <li>
  86                 <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
  87         </li>
  88
  89         <li>
  90                 <a href="../modules/luci.model.uci.html">luci.model.uci</a>
  91         </li>
  92
  93         <li>
  94                 <a href="../modules/luci.rpcc.html">luci.rpcc</a>
  95         </li>
  96
  97         <li>
  98                 <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
  99         </li>
 100
 101         <li>
 102                 <a href="../modules/luci.sys.html">luci.sys</a>
 103         </li>
 104
 105         <li>
 106                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
 107         </li>
 108
 109         <li>
 110                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
 111         </li>
 112
 113         <li>
 114                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
 115         </li>
 116
 117         <li><strong>luci.sys.process</strong></li>
 118
 119         <li>
 120                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
 121         </li>
 122
 123         <li>
 124                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
 125         </li>
 126
 127         <li>
 128                 <a href="../modules/luci.util.html">luci.util</a>
 129         </li>
 130
 131         <li>
 132                 <a href="../modules/nixio.html">nixio</a>
 133         </li>
 134
 135         <li>
 136                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 137         </li>
 138
 139         <li>
 140                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 141         </li>
 142
 143         <li>
 144                 <a href="../modules/nixio.File.html">nixio.File</a>
 145         </li>
 146
 147         <li>
 148                 <a href="../modules/nixio.README.html">nixio.README</a>
 149         </li>
 150
 151         <li>
 152                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 153         </li>
 154
 155         <li>
 156                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
 157         </li>
 158
 159         <li>
 160                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 161         </li>
 162
 163         <li>
 164                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 165         </li>
 166
 167         <li>
 168                 <a href="../modules/nixio.bin.html">nixio.bin</a>
 169         </li>
 170
 171         <li>
 172                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 173         </li>
 174
 175         <li>
 176                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 177         </li>
 178
 179         <li>
 180                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 181         </li>
 182
 183 </ul>
 184
 185
 186
 187 <!-- File list -->
 188
 189
 190
 191
 192
 193
 194
 195 </div><!-- id="navigation" -->
 196
 197 <div id="content">
 198
 199 <h1>Class <code>luci.sys.process</code></h1>
 200
 201 <p>
 202
 203 LuCI system utilities / process related functions.
 204 </p>
 205
 206
 207
 208
 209
 210
 211
 212 <h2>Functions</h2>
 213 <table class="function_list">
 214
 215         <tr>
 216         <td class="name" nowrap><a href="#process.info">info</a>&nbsp;()</td>
 217         <td class="summary">
 218
 219 Get the current process id.</td>
 220         </tr>
 221
 222         <tr>
 223         <td class="name" nowrap><a href="#process.list">list</a>&nbsp;()</td>
 224         <td class="summary">
 225
 226 Retrieve information about currently running processes.</td>
 227         </tr>
 228
 229         <tr>
 230         <td class="name" nowrap><a href="#process.setgroup">setgroup</a>&nbsp;(gid)</td>
 231         <td class="summary">
 232
 233 Set the gid of a process identified by given pid.</td>
 234         </tr>
 235
 236         <tr>
 237         <td class="name" nowrap><a href="#process.setuser">setuser</a>&nbsp;(uid)</td>
 238         <td class="summary">
 239
 240 Set the uid of a process identified by given pid.</td>
 241         </tr>
 242
 243         <tr>
 244         <td class="name" nowrap><a href="#process.signal">signal</a>&nbsp;(pid, sig)</td>
 245         <td class="summary">
 246
 247 Send a signal to a process identified by given pid.</td>
 248         </tr>
 249
 250 </table>
 251
 252
 253
 254
 255
 256
 257 <br/>
 258 <br/>
 259
 260
 261 <h2><a name="functions"></a>Functions</h2>
 262 <dl class="function">
 263
 264
 265
 266 <dt><a name="process.info"></a><strong>info</strong>&nbsp;()</dt>
 267 <dd>
 268
 269
 270 Get the current process id.
 271
 272
 273
 274
 275
 276
 277
 278
 279 <h3>Return value:</h3>
 280 Number containing the current pid
 281
 282
 283
 284 </dd>
 285
 286
 287
 288
 289 <dt><a name="process.list"></a><strong>list</strong>&nbsp;()</dt>
 290 <dd>
 291
 292
 293 Retrieve information about currently running processes.
 294
 295
 296
 297
 298
 299
 300
 301
 302 <h3>Return value:</h3>
 303 Table containing process information
 304
 305
 306
 307 </dd>
 308
 309
 310
 311
 312 <dt><a name="process.setgroup"></a><strong>setgroup</strong>&nbsp;(gid)</dt>
 313 <dd>
 314
 315
 316 Set the gid of a process identified by given pid.
 317
 318
 319
 320 <h3>Parameters</h3>
 321 <ul>
 322
 323         <li>
 324           gid: Number containing the Unix group id
 325         </li>
 326
 327 </ul>
 328
 329
 330
 331
 332
 333
 334 <h3>Return values:</h3>
 335 <ol>
 336
 337         <li>Boolean indicating successful operation
 338
 339         <li>String containing the error message if failed
 340
 341         <li>Number containing the error code if failed
 342
 343 </ol>
 344
 345
 346
 347 </dd>
 348
 349
 350
 351
 352 <dt><a name="process.setuser"></a><strong>setuser</strong>&nbsp;(uid)</dt>
 353 <dd>
 354
 355
 356 Set the uid of a process identified by given pid.
 357
 358
 359
 360 <h3>Parameters</h3>
 361 <ul>
 362
 363         <li>
 364           uid: Number containing the Unix user id
 365         </li>
 366
 367 </ul>
 368
 369
 370
 371
 372
 373
 374 <h3>Return values:</h3>
 375 <ol>
 376
 377         <li>Boolean indicating successful operation
 378
 379         <li>String containing the error message if failed
 380
 381         <li>Number containing the error code if failed
 382
 383 </ol>
 384
 385
 386
 387 </dd>
 388
 389
 390
 391
 392 <dt><a name="process.signal"></a><strong>signal</strong>&nbsp;(pid, sig)</dt>
 393 <dd>
 394
 395
 396 Send a signal to a process identified by given pid.
 397
 398
 399
 400 <h3>Parameters</h3>
 401 <ul>
 402
 403         <li>
 404           pid: Number containing the process id
 405         </li>
 406
 407         <li>
 408           sig: Signal to send (default: 15 [SIGTERM])
 409         </li>
 410
 411 </ul>
 412
 413
 414
 415
 416
 417
 418 <h3>Return values:</h3>
 419 <ol>
 420
 421         <li>Boolean indicating successful operation
 422
 423         <li>Number containing the error code if failed
 424
 425 </ol>
 426
 427
 428
 429 </dd>
 430
 431
 432 </dl>
 433
 434
 435
 436
 437
 438 </div> <!-- id="content" -->
 439
 440 </div> <!-- id="main" -->
 441
 442 <div id="about">
 443         <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
 444 </div> <!-- id="about" -->
 445
 446 </div> <!-- id="container" -->
 447 </body>
 448 </html>