← Back to branch summary

~ubuntu-branches/debian/sid/kamailio/sid

« back to all changes in this revision

Viewing changes to modules/app_lua/doc/app_lua_admin.xml

  • Committer: Package Import Robot
  • Author(s): Victor Seva
  • Date: 2014-01-06 11:47:13 UTC
  • mfrom: (1.1.5)
  • Revision ID: package-import@ubuntu.com-20140106114713-t8xidp4arzrnyeya
Tags: 4.1.1-1
http://bugs.debian.org/728915
* New upstream release
* debian/patches:
  - add upstream fixes
* Added tls outbound websocket autheph dnssec modules
  - openssl exception added to their license
* removing sparc and ia64 from supported archs
  for mono module (Closes: #728915)

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/app_lua/doc/app_lua_admin.xml
11
11
<!-- Module User's Guide -->
12
12
 
13
13
<chapter>
14
 
    
 
14
 
15
15
    <title>&adminguide;</title>
16
 
    
 
16
 
17
17
    <section>
18
18
        <title>Overview</title>
19
19
        <para>
80
80
    </section>
81
81
    <section>
82
82
        <title>Parameters</title>
83
 
        <section>
 
83
        <section id="app_lua.p.load">
84
84
            <title><varname>load</varname> (string)</title>
85
85
            <para>
86
86
                        Set the path to the Lua script to be loaded at startup. Then you
102
102
            </example>
103
103
        </section>
104
104
 
105
 
        <section>
 
105
        <section id="app_lua.p.register">
106
106
            <title><varname>register</varname> (string)</title>
107
107
            <para>
108
108
                        Use this function to register optional SIP Router submodules
249
249
            </example>
250
250
        </section>
251
251
 
252
 
        </section>
253
 
        
 
252
        <section id="app_lua.p.reload">
 
253
            <title><varname>reload</varname> (boolean)</title>
 
254
            <para>
 
255
                        If reload is 1 enables the ability to reload the
 
256
                        scripts using the RPC app_lua.reload command.
 
257
            </para>
 
258
            <para>
 
259
                <emphasis>
 
260
                    Default value is <quote>0 (off)</quote>.
 
261
                </emphasis>
 
262
            </para>
 
263
            <example>
 
264
                <title>Set <varname>reload</varname> parameter</title>
 
265
                <programlisting format="linespecific">
 
266
...
 
267
modparam("app_lua", "reload", 1)
 
268
...
 
269
</programlisting>
 
270
            </example>
 
271
        </section>
 
272
 
 
273
        </section>
 
274
 
254
275
    <section>
255
276
        <title>Functions</title>
256
 
        <section>
 
277
        <section id="app_lua.f.lua_dotfile">
257
278
            <title>
258
279
                <function moreinfo="none">lua_dofile(path)</function>
259
280
            </title>
270
291
</programlisting>
271
292
            </example>
272
293
        </section>
273
 
        
274
 
        <section>
 
294
 
 
295
        <section id="app_lua.f.lua_dostring">
275
296
            <title>
276
297
                <function moreinfo="none">lua_dostring(script)</function>
277
298
            </title>
292
313
            </example>
293
314
        </section>
294
315
 
295
 
        <section>
 
316
        <section id="app_lua.f.lua_run">
296
317
            <title>
297
318
                <function moreinfo="none">lua_run(function, params)</function>
298
319
            </title>
317
338
            </example>
318
339
        </section>
319
340
 
320
 
        <section>
 
341
        <section id="app_lua.f.lua_runstring">
321
342
            <title>
322
343
                <function moreinfo="none">lua_runstring(script)</function>
323
344
            </title>
338
359
</programlisting>
339
360
            </example>
340
361
        </section>
341
 
        
342
 
    </section>
343
 
        
 
362
 
 
363
    </section>
 
364
 
 
365
    <section>
 
366
        <title>Exported RPC Commands</title>
 
367
        <section id="app_lua.r.list">
 
368
            <title>
 
369
            <function moreinfo="none">app_lua.list</function>
 
370
            </title>
 
371
            <para>
 
372
            Lists the id and path for every script loaded by
 
373
            the load parameter.
 
374
            </para>
 
375
            <para>
 
376
            Name: <emphasis>app_lua.list</emphasis>
 
377
            </para>
 
378
            <para>Parameters: <emphasis>none</emphasis></para>
 
379
            <para>
 
380
            Example:
 
381
            </para>
 
382
            <programlisting  format="linespecific">
 
383
                &sercmd; app_lua.lists
 
384
            </programlisting>
 
385
        </section>
 
386
        <section id="app_lua.r.reload">
 
387
            <title>
 
388
            <function moreinfo="none">app_lua.reload</function>
 
389
            </title>
 
390
            <para>
 
391
            Marks the need to reload the selected script.
 
392
            The actual reload is done by every working process when the next
 
393
            call to lua_run function is executed.
 
394
            If no parameter is added all the scripts are selected to be reloaded.
 
395
            </para>
 
396
            <para>
 
397
            Name: <emphasis>app_lua.reload</emphasis>
 
398
            </para>
 
399
            <para>Parameters: <emphasis>id</emphasis></para>
 
400
            <para>
 
401
            Example:
 
402
            </para>
 
403
            <programlisting  format="linespecific">
 
404
                &sercmd; app_lua.reload 0
 
405
            </programlisting>
 
406
        </section>
 
407
    </section>
 
408
 
344
409
    <section>
345
410
        <title>Example of usage</title>
346
411
    <para>