Skip to content

Commit 58a16d8

Browse files
committed
Sync param names with opensips_cli
1 parent 389daea commit 58a16d8

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/mi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This package can be used to execute OpenSIPS Management Interface (MI) commands.
66

77
The following communication types are supported:
88
* `http` - uses the HTTP protocol to communicate with the MI interface. Requires the `url` parameter to be set.
9-
* `datagram` - uses the UDP protocol to communicate with the MI interface. Requires the `ip` and `port` parameters to be set.
9+
* `datagram` - uses the UDP protocol to communicate with the MI interface. Requires the `datagram_ip` and `datagram_port` parameters to be set.
1010
* `fifo` - uses a FIFO file to communicate with the MI interface. Requires 3 parameters: `fifo_file`, `fifo_file_fallback` and `fifo_reply_dir`.
1111

1212
To instantiate the `OpenSIPSMI` class, you need to provide the communication type and the required parameters in a key-value format. For example:
@@ -15,7 +15,7 @@ To instantiate the `OpenSIPSMI` class, you need to provide the communication typ
1515
mi = OpenSIPSMI('http', url='http://localhost:8888/mi')
1616

1717
# or
18-
mi = OpenSIPSMI('datagram', ip='127.0.0.1', port=8080)
18+
mi = OpenSIPSMI('datagram', datagram_ip='127.0.0.1', datagram_port=8080)
1919

2020
# or
2121
mi = OpenSIPSMI('fifo', fifo_file='/tmp/opensips_fifo', fifo_file_fallback='/tmp/opensips_fifo_fallback', fifo_reply_dir='/tmp/opensips/')

0 commit comments

Comments
 (0)