Ver código fonte

modules: readme files regenerated - jsonrpcs ... [skip ci]

Kamailio Dev 7 anos atrás
pai
commit
27caae0fe2
1 arquivos alterados com 15 adições e 11 exclusões
  1. 15 11
      src/modules/jsonrpcs/README

+ 15 - 11
src/modules/jsonrpcs/README

@@ -18,7 +18,7 @@ Daniel-Constantin Mierla
    1. Admin Guide
 
         1. Overview
-        2. Limitations
+        2. Important Remarks
         3. Dependencies
 
               3.1. Kamailio Modules
@@ -78,7 +78,7 @@ Chapter 1. Admin Guide
    Table of Contents
 
    1. Overview
-   2. Limitations
+   2. Important Remarks
    3. Dependencies
 
         3.1. Kamailio Modules
@@ -114,24 +114,28 @@ Chapter 1. Admin Guide
 
 1. Overview
 
-   This module provides a JSON-RPC v2 server over HTTP implementation,
-   tailored for the needs of Kamailio. It implements the Kamailio RPC
-   interface over JSON-RPC.
+   This module provides a JSON-RPC v2 server, tailored for the needs of
+   Kamailio. It implements the Kamailio RPC interface over JSON-RPC.
 
    The specification for JSON-RPC is available at:
    http://www.jsonrpc.org/specification.
 
-   The JSONRPC-S module uses the xHTTP module to handle HTTP/S requests.
-   Read the documentation of the xHTTP module for more details.
+   The transports supported by the module are: FIFO file, datagram (UDP)
+   over unix socket files or network sockets, HTTP and HTTPS.
 
-2. Limitations
+   The JSONRPCS module requires the xHTTP module to handle HTTP/S
+   requests. Read the documentation of the xHTTP module for more details.
 
-     * This module does not implement asynchronous RPC commands. It is
-       unlikely that asynchronous RPC commands will be executed from an
-       JSON-RPC over HTTP client.
+2. Important Remarks
+
+     * This module implements the support for asynchronous RPC commands
+       only for HTTP and HTTPS transports.
      * This module does not accept parameters embedded in a structure (see
        the RPC documentation for more info about how parameters can be
        passed to RPC).
+     * For the RPC interface implemented by Kamailio, the order of
+       parameters is important. If the parameters are given with names,
+       the names are ignored.
 
 3. Dependencies