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.protocol.html">luci.http.protocol</a>
  43         </li>
  44
  45         <li>
  46                 <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
  47         </li>
  48
  49         <li>
  50                 <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
  51         </li>
  52
  53         <li>
  54                 <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
  55         </li>
  56
  57         <li>
  58                 <a href="../modules/luci.i18n.html">luci.i18n</a>
  59         </li>
  60
  61         <li>
  62                 <a href="../modules/luci.ip.html">luci.ip</a>
  63         </li>
  64
  65         <li>
  66                 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
  67         </li>
  68
  69         <li>
  70                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  71         </li>
  72
  73         <li>
  74                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  75         </li>
  76
  77         <li>
  78                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
  79         </li>
  80
  81         <li>
  82                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
  83         </li>
  84
  85         <li>
  86                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
  87         </li>
  88
  89         <li><strong>luci.sys.process</strong></li>
  90
  91         <li>
  92                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
  93         </li>
  94
  95         <li>
  96                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
  97         </li>
  98
  99         <li>
 100                 <a href="../modules/nixio.html">nixio</a>
 101         </li>
 102
 103         <li>
 104                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 105         </li>
 106
 107         <li>
 108                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 109         </li>
 110
 111         <li>
 112                 <a href="../modules/nixio.File.html">nixio.File</a>
 113         </li>
 114
 115         <li>
 116                 <a href="../modules/nixio.README.html">nixio.README</a>
 117         </li>
 118
 119         <li>
 120                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 121         </li>
 122
 123         <li>
 124                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
 125         </li>
 126
 127         <li>
 128                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 129         </li>
 130
 131         <li>
 132                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 133         </li>
 134
 135         <li>
 136                 <a href="../modules/nixio.bin.html">nixio.bin</a>
 137         </li>
 138
 139         <li>
 140                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 141         </li>
 142
 143         <li>
 144                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 145         </li>
 146
 147         <li>
 148                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 149         </li>
 150
 151 </ul>
 152
 153
 154
 155 <!-- File list -->
 156
 157
 158
 159
 160
 161
 162
 163 </div><!-- id="navigation" -->
 164
 165 <div id="content">
 166
 167 <h1>Class <code>luci.sys.process</code></h1>
 168
 169 <p>
 170
 171 LuCI system utilities / process related functions.
 172 </p>
 173
 174
 175
 176
 177
 178
 179
 180 <h2>Functions</h2>
 181 <table class="function_list">
 182
 183         <tr>
 184         <td class="name" nowrap><a href="#process.info">info</a>&nbsp;()</td>
 185         <td class="summary">
 186
 187 Get the current process id.</td>
 188         </tr>
 189
 190         <tr>
 191         <td class="name" nowrap><a href="#process.list">list</a>&nbsp;()</td>
 192         <td class="summary">
 193
 194 Retrieve information about currently running processes.</td>
 195         </tr>
 196
 197         <tr>
 198         <td class="name" nowrap><a href="#process.setgroup">setgroup</a>&nbsp;(gid)</td>
 199         <td class="summary">
 200
 201 Set the gid of a process identified by given pid.</td>
 202         </tr>
 203
 204         <tr>
 205         <td class="name" nowrap><a href="#process.setuser">setuser</a>&nbsp;(uid)</td>
 206         <td class="summary">
 207
 208 Set the uid of a process identified by given pid.</td>
 209         </tr>
 210
 211         <tr>
 212         <td class="name" nowrap><a href="#process.signal">signal</a>&nbsp;(pid, sig)</td>
 213         <td class="summary">
 214
 215 Send a signal to a process identified by given pid.</td>
 216         </tr>
 217
 218 </table>
 219
 220
 221
 222
 223
 224
 225 <br/>
 226 <br/>
 227
 228
 229 <h2><a name="functions"></a>Functions</h2>
 230 <dl class="function">
 231
 232
 233
 234 <dt><a name="process.info"></a><strong>info</strong>&nbsp;()</dt>
 235 <dd>
 236
 237
 238 Get the current process id.
 239
 240
 241
 242
 243
 244
 245
 246
 247 <h3>Return value:</h3>
 248 Number containing the current pid
 249
 250
 251
 252 </dd>
 253
 254
 255
 256
 257 <dt><a name="process.list"></a><strong>list</strong>&nbsp;()</dt>
 258 <dd>
 259
 260
 261 Retrieve information about currently running processes.
 262
 263
 264
 265
 266
 267
 268
 269
 270 <h3>Return value:</h3>
 271 Table containing process information
 272
 273
 274
 275 </dd>
 276
 277
 278
 279
 280 <dt><a name="process.setgroup"></a><strong>setgroup</strong>&nbsp;(gid)</dt>
 281 <dd>
 282
 283
 284 Set the gid of a process identified by given pid.
 285
 286
 287
 288 <h3>Parameters</h3>
 289 <ul>
 290
 291         <li>
 292           gid: Number containing the Unix group id
 293         </li>
 294
 295 </ul>
 296
 297
 298
 299
 300
 301
 302 <h3>Return values:</h3>
 303 <ol>
 304
 305         <li>Boolean indicating successful operation
 306
 307         <li>String containing the error message if failed
 308
 309         <li>Number containing the error code if failed
 310
 311 </ol>
 312
 313
 314
 315 </dd>
 316
 317
 318
 319
 320 <dt><a name="process.setuser"></a><strong>setuser</strong>&nbsp;(uid)</dt>
 321 <dd>
 322
 323
 324 Set the uid of a process identified by given pid.
 325
 326
 327
 328 <h3>Parameters</h3>
 329 <ul>
 330
 331         <li>
 332           uid: Number containing the Unix user id
 333         </li>
 334
 335 </ul>
 336
 337
 338
 339
 340
 341
 342 <h3>Return values:</h3>
 343 <ol>
 344
 345         <li>Boolean indicating successful operation
 346
 347         <li>String containing the error message if failed
 348
 349         <li>Number containing the error code if failed
 350
 351 </ol>
 352
 353
 354
 355 </dd>
 356
 357
 358
 359
 360 <dt><a name="process.signal"></a><strong>signal</strong>&nbsp;(pid, sig)</dt>
 361 <dd>
 362
 363
 364 Send a signal to a process identified by given pid.
 365
 366
 367
 368 <h3>Parameters</h3>
 369 <ul>
 370
 371         <li>
 372           pid: Number containing the process id
 373         </li>
 374
 375         <li>
 376           sig: Signal to send (default: 15 [SIGTERM])
 377         </li>
 378
 379 </ul>
 380
 381
 382
 383
 384
 385
 386 <h3>Return values:</h3>
 387 <ol>
 388
 389         <li>Boolean indicating successful operation
 390
 391         <li>Number containing the error code if failed
 392
 393 </ol>
 394
 395
 396
 397 </dd>
 398
 399
 400 </dl>
 401
 402
 403
 404
 405
 406 </div> <!-- id="content" -->
 407
 408 </div> <!-- id="main" -->
 409
 410 <div id="about">
 411         <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>
 412 </div> <!-- id="about" -->
 413
 414 </div> <!-- id="container" -->
 415 </body>
 416 </html>