Skip to content

Commit 1102eb9

Browse files
committed
CDRIVER-3326 Document mongoc_client_session_get_server_id
1 parent 6f73903 commit 1102eb9

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
:man_page: mongoc_client_session_get_server_id
2+
3+
mongoc_client_session_get_server_id()
4+
=====================================
5+
6+
Synopsis
7+
--------
8+
9+
.. code-block:: c
10+
11+
uint32_t
12+
mongoc_client_session_get_server_id (const mongoc_client_session_t *session);
13+
14+
Get the "server ID" of the ``mongos`` this :symbol:`mongoc_client_session_t` is pinned to.
15+
16+
Parameters
17+
----------
18+
19+
* ``session``: A :symbol:`mongoc_client_session_t`.
20+
21+
Returns
22+
-------
23+
24+
A server ID or ``0`` if this :symbol:`mongoc_client_session_t` is not pinned.
25+
26+
.. only:: html
27+
28+
.. taglist:: See Also:
29+
:tags: session
30+

src/libmongoc/doc/mongoc_client_session_t.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,5 @@ Example
4040
mongoc_client_session_get_operation_time
4141
mongoc_client_session_get_opts
4242
mongoc_client_session_get_lsid
43+
mongoc_client_session_get_server_id
4344
mongoc_client_session_destroy

0 commit comments

Comments
 (0)