Skip to content

Commit 8ecf633

Browse files
author
Christian Hergert
committed
apidoc: add mongoc_client_pool_set_ssl_opts().
1 parent 2c0cc68 commit 8ecf633

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<?xml version="1.0"?>
2+
<page xmlns="http://projectmallard.org/1.0/"
3+
type="topic"
4+
style="function"
5+
xmlns:api="http://projectmallard.org/experimental/api/"
6+
xmlns:ui="http://projectmallard.org/experimental/ui/"
7+
id="mongoc_client_pool_set_ssl_opts">
8+
<info>
9+
<link type="guide" xref="mongoc_client_pool_t" group="function"/>
10+
</info>
11+
<title>mongoc_client_pool_set_ssl_opts()</title>
12+
13+
<section id="synopsis">
14+
<title>Synopsis</title>
15+
<synopsis><code mime="text/x-csrc"><![CDATA[#ifdef MONGOC_ENABLE_SSL
16+
void
17+
mongoc_client_pool_set_ssl_opts (mongoc_client_pool_t *pool,
18+
const mongoc_ssl_opt_t *opts);
19+
#endif]]></code></synopsis>
20+
<p>This function is identical to <link xref="mongoc_client_set_ssl_opts">mongoc_client_set_ssl_opts()</link> except for client pools. It ensures that all clients retrieved from <link xref="mongoc_client_pool_pop">mongoc_client_pool_pop()</link> or <link xref="mongoc_client_pool_try_pop">mongoc_client_pool_try_pop()</link> are configured with the same SSL settings.</p>
21+
<p>It is a programming error to call this function after retrieving a client from the client pool.</p>
22+
</section>
23+
24+
<section id="parameters">
25+
<title>Parameters</title>
26+
<table>
27+
<tr><td><p>pool</p></td><td><p>A <link xref="mongoc_client_pool_t">mongoc_client_pool_t</link>.</p></td></tr>
28+
<tr><td><p>opts</p></td><td><p>A <link xref="mongoc_ssl_opt_t">mongoc_ssl_opt_t</link> that will not be modified.</p></td></tr>
29+
</table>
30+
</section>
31+
32+
<section id="parameters">
33+
<title>Availability</title>
34+
<p>Since 0.94.4</p>
35+
<p>This feature requires that the MongoDB C driver was compiled with <code>--enable-ssl</code>.</p>
36+
</section>
37+
38+
</page>

0 commit comments

Comments
 (0)