====== FIFO Interface ======

Valid for OpenSER 1.0.x.

==== utils/fifo_server.php ====

The utils/fifo_server.php program requires the two configuration files listed below:

fifo_server.cfg:

<code>
<?php
$fifo_server_address = "192.168.1.1";
$fifo_server_port    = "12345";
?>
</code>

fifo_server.clients:

<code>
# List IP addresses (one per line) of all hosts that are allowed to
# send commands to OpenSER FIFO:
192.168.1.2
</code>

==== FIFO Commands ====

==== DB ====

==== meminfo ====

Command:

<code>
:meminfo:REPLY_FILE_NAME
</code>

Response:

<code>
200 ok
total:33537872
free:31927176
used:1610696
max used:0
fragments:13
</code>

==== kill ====

==== ps ====

==== which ====

==== arg ====

==== pwd ====

==== version ====

Command:

:version:REPLY_FILE_NAME

Response:

<code>
200 ok
Server: OpenSer (1.1.0-dev0 -tls (i386/freebsd))
</code>

==== uptime ====

Command:

<code>
:uptime:REPLY_FILE_NAME
</code>

Response:

<code>
200 ok
Now: Wed Nov  2 19:09:08 2005
Up Since: Wed Nov  2 15:03:54 2005
Up time: 14714 [sec]
</code>

==== print ====

==== print_timer_list ====

==== print_ip_tree ====

==== pdt_list ====

==== pdt_delete ====

==== pdt_add ====

==== trusted_dump ====

==== trusted_reload ====

==== domain_dump ====

==== domain_reload ====

==== ul_show_contact ====

Command:

<code>
:ul_show_contact:REPLY_FILE_NAME
location
1234
</code>

Response:

<code>
200 OK
;q=0.1;expires=2411
</code>

==== ul_add ====

Command:

<code>
:ul_add:REPLY_FILE_NAME
location
1234@example.com
sip:18005551212@example.com
3600
1.00
0
1
</code>

Response:

<code>
200 Added to table
('1234','sip:18005551212@example.com') to 'location'
</code>

==== ul_flush ====

==== ul_dump ====

==== ul_rm_contact ====

==== ul_rm ====

==== ul_stats ====

Command:

<code>
:ul_stats:REPLY_FILE_NAME
</code>

Response:

<code>
200 ok
Domain Registered Expired
'aliases' 0 0
'location' 10 0
</code>

==== t_stats ====

Comand:

<code>
:t_stats:REPLY_FILE_NAME
</code>

Response:

<code>
200 ok
Current: 2 (2 waiting) Total: 7 (0 local)
Replied localy: 13
Completion status 6xx: 0, 5xx: 0, 4xx: 0, 3xx: 0,2xx: 7
</code>

==== t_reply ====

==== t_hash ====

==== t_uac_cancel ====

==== t_uac_dlg ====


==== sl_stats ====

Command:

<code>
:sl_stats:REPLY_FILE_NAME
</code>

Response:

<code>
200 ok
200: 823 202: 0 2xx: 0
300: 0 301: 0 302: 0 3xx: 0
400: 0 401: 154 403: 0 404: 0 407: 0 408: 0 483: 0 4xx: 0
500: 0 5xx: 0
6xx: 0
xxx: 493
failures: 0
</code>

===== See also =====

SER FIFO Interface document [[http://iptel.org/~janakj/fifo.pdf]]