[sr-dev] git:master:d1fbec62: ndb_mongodb: note about mongodb c driver version and tls

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: d1fbec620bdb923aace665170ddabedddd2a3697
URL: https://github.com/kamailio/kamailio/commit/d1fbec620bdb923aace665170ddabedddd2a3697

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2016-05-30T12:03:02+02:00

ndb_mongodb: note about mongodb c driver version and tls

---

Modified: modules/ndb_mongodb/README
Modified: modules/ndb_mongodb/doc/ndb_mongodb_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/d1fbec620bdb923aace665170ddabedddd2a3697.diff
Patch: https://github.com/kamailio/kamailio/commit/d1fbec620bdb923aace665170ddabedddd2a3697.patch

---

diff --git a/modules/ndb_mongodb/README b/modules/ndb_mongodb/README
index 01b1ce5..e9a9702 100644
--- a/modules/ndb_mongodb/README
+++ b/modules/ndb_mongodb/README
@@ -10,7 +10,7 @@ Daniel-Constantin Mierla
 
    <miconda at gmail.com>
 
-   Copyright © 2014 asipto.com
+   Copyright © 2014 asipto.com
      __________________________________________________________________
 
    Table of Contents
@@ -98,6 +98,8 @@ Chapter 1. Admin Guide
    running Kamailio with this module loaded:
      * mongo-c-driver - available at
        https://github.com/mongodb/mongo-c-driver
+       Note: if you use tls module, use at least mongo-c-driver v1.2.1 -
+       there were reports of issues inside earlier versions of the driver.
 
 3. Parameters
 
@@ -133,7 +135,7 @@ modparam("ndb_mongodb", "server", "name=mgs2;uri='mongodb://127.0.0.2/kamailio'"
    4.5. mongodb_next(replyid)
    4.6. mongodb_free(replyid)
 
-4.1.  mongodb_cmd(srvname, dbname, cname, command, replyid)
+4.1. mongodb_cmd(srvname, dbname, cname, command, replyid)
 
    Send a valid command to MongoDB server identified by srvname. The reply
    will be stored in a local container identified by replyid. All the
@@ -165,7 +167,7 @@ if(mongodb_cmd("mgs1", "kamailio", "acc", "{ \"collStats\": \"acc\" }", "mgr1"))
 }
 ...
 
-4.2.  mongodb_cmd_simple(srvname, dbname, cname, command, replyid)
+4.2. mongodb_cmd_simple(srvname, dbname, cname, command, replyid)
 
    Send a valid command to MongoDB server identified by srvname. The reply
    will be stored in a local container identified by replyid. All the
@@ -191,7 +193,7 @@ mgr1")) {
 }
 ...
 
-4.3.  mongodb_find(srvname, dbname, cname, command, replyid)
+4.3. mongodb_find(srvname, dbname, cname, command, replyid)
 
    Send a find command to MongoDB server identified by srvname. The reply
    will be stored in a local container identified by replyid. All the
@@ -220,7 +222,7 @@ if(mongodb_find("mgs1", "kamailio", "acc", "{ \"src_user\" : \"111\" }", "mgr1")
 }
 ...
 
-4.4.  mongodb_find_one(srvname, dbname, cname, command, replyid)
+4.4. mongodb_find_one(srvname, dbname, cname, command, replyid)
 
    Similar to mongodb_find(...), but it stops searching after first match,
    returning the result with one object - faster when expecting to have a
@@ -237,7 +239,7 @@ if(mongodb_find_one("mgs1", "kamailio", "subscriber", "{ \"username\" : \"111\"
 }
 ...
 
-4.5.  mongodb_next(replyid)
+4.5. mongodb_next(replyid)
 
    Moves to next document in a MongoDB reply. This function can be used
    after a succesful mongodb_cmd() or mongodb_find(). It returns true if
@@ -256,7 +258,7 @@ if(mongodb_find("mgs1", "kamailio", "acc", "{ \"src_user\" : \"111\" }", "mgr1")
 mongodb_free("mgr1");
 ...
 
-4.6.  mongodb_free(replyid)
+4.6. mongodb_free(replyid)
 
    Frees data in a previous reply from memory. After this function call,
    accessing to a freed replyid returns null value.
diff --git a/modules/ndb_mongodb/doc/ndb_mongodb_admin.xml b/modules/ndb_mongodb/doc/ndb_mongodb_admin.xml
index ec43474..d6e5a3c 100644
--- a/modules/ndb_mongodb/doc/ndb_mongodb_admin.xml
+++ b/modules/ndb_mongodb/doc/ndb_mongodb_admin.xml
@@ -52,6 +52,10 @@
 				<emphasis>mongo-c-driver</emphasis> - available at
 				<ulink url="https://github.com/mongodb/mongo-c-driver">https://github.com/mongodb/mongo-c-driver</ulink>
 			</para>
+			<para>
+				Note: if you use tls module, use at least mongo-c-driver v1.2.1
+				- there were reports of issues inside earlier versions of the driver.
+			</para>
 			</listitem>
 			</itemizedlist>
 		</para>