Skip to content

Commit dc1047b

Browse files
committed
doc: more docs for added symbols.
1 parent 54eeee7 commit dc1047b

12 files changed

+161
-13
lines changed

doc/mongoc_cursor_is_alive.txt

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
mongoc_cursor_is_alive(3)
2+
=========================
3+
4+
5+
NAME
6+
----
7+
mongoc_collection_is_alive - determine if a tailable cursor is still alive
8+
9+
10+
SYNOPSIS
11+
--------
12+
[source,c]
13+
-----------------------
14+
bool mongoc_cursor_is_alive (const mongoc_cursor_t *);
15+
-----------------------
16+
17+
18+
DESCRIPTION
19+
-----------
20+
The _mongoc_cursor_is_alive()_ function checks to see if a cursor
21+
is in a state that allows for more documents to be queried.
22+
23+
This is primarily useful with tailable cursors.
24+
25+
26+
RETURN VALUE
27+
------------
28+
true if there may be more content to retrieve from a cursor.
29+
30+
31+
AUTHORS
32+
-------
33+
This page was written by MongoDB, Inc.

doc/mongoc_log_level_str.txt

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
mongoc_log_level_str(3)
2+
=======================
3+
4+
5+
NAME
6+
----
7+
mongoc_log_level_str - convert a log level to a string
8+
9+
10+
SYNOPSIS
11+
--------
12+
[source,c]
13+
-----------------------
14+
const char *mongoc_log_level_str (mongoc_log_level_t log_level);
15+
-----------------------
16+
17+
18+
DESCRIPTION
19+
-----------
20+
This is a convenience function to convert a log level enumeration
21+
to a string. The string should not be modified or freed.
22+
23+
24+
RETURN VALUE
25+
------------
26+
The log level as a string.
27+
28+
29+
AUTHORS
30+
-------
31+
This page was written by MongoDB, Inc.

doc/mongoc_socket_getnameinfo.txt

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
mongoc_socket_getnameinfo(3)
2+
============================
3+
4+
5+
NAME
6+
----
7+
mongoc_socket_getnameinfo - get the name for a socket
8+
9+
10+
SYNOPSIS
11+
--------
12+
13+
[source, c]
14+
---------------
15+
#include <mongoc.h>
16+
17+
char *mongoc_socket_getnameinfo (mongoc_socket_t *sock);
18+
---------------
19+
20+
21+
DESCRIPTION
22+
-----------
23+
The _mongoc_socket_getnameinfo()_ function is the equivalent of calling
24+
_getnameinfo()_ on the underlying socket and returning a copy of the resulting
25+
host parameter.
26+
27+
The caller should free the result with _bson_free()_.
28+
29+
30+
ERRORS
31+
------
32+
Upon an error from the underlying socket, NULL is returned.
33+
34+
35+
AUTHORS
36+
-------
37+
This page was written by MongoDB, Inc.

doc/mongoc_stream_get_base_stream.txt

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
mongoc_stream_get_base_stream(3)
2+
================================
3+
4+
5+
NAME
6+
----
7+
mongoc_stream_get_base_stream - get the underlying stream from a stream
8+
9+
10+
SYNOPSIS
11+
--------
12+
13+
[source, c]
14+
---------------
15+
#include <mongoc.h>
16+
17+
mongoc_stream_t *mongoc_stream_get_base_stream (mongoc_stream_t *stream);
18+
---------------
19+
20+
21+
DESCRIPTION
22+
-----------
23+
Some streams such as TLS and buffered streams have a base stream beneath
24+
them. This function returns that base stream.
25+
26+
Not all streams have underlying streams, for which NULL is returned.
27+
28+
29+
AUTHORS
30+
-------
31+
This page was written by MongoDB, Inc.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
mongoc_stream_socket_new.txt

doc/mongoc_stream_socket_new.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ SYNOPSIS
1414
#include <mongoc.h>
1515

1616
mongoc_stream_t *mongoc_stream_socket_new (mongoc_socket_t *socket);
17+
mongoc_socket_t *mongoc_stream_socket_get_socket (mongoc_stream_socket_t *stream);
1718
-----------------------
1819

1920

@@ -25,11 +26,13 @@ linkmongoc:mongoc_stream[7], taking ownership of the _mongoc_socket_t_.
2526
socket::
2627
The _mongoc_socket_t_ for the stream to take ownership of.
2728

29+
The _mongoc_stream_socket_get_socket()_ function shall return the underlying socket.
30+
2831

2932
RETURN VALUE
3033
------------
31-
This function always returns a newly allocated mongoc_stream_t instance.
32-
It should be freed with mongoc_stream_destroy().
34+
The _mongoc_stream_socket_new()_ function always returns a newly allocated
35+
mongoc_stream_t instance. It should be freed with mongoc_stream_destroy().
3336

3437

3538
SEE ALSO

doc/mongoc_uri_get_hosts.txt

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,28 @@ NAME
77
mongoc_uri_get_hosts, mongoc_uri_get_database, mongoc_uri_get_options,
88
mongoc_uri_get_password, mongoc_uri_get_read_prefs,
99
mongoc_uri_get_replica_set, mongoc_uri_get_string, mongoc_uri_get_username,
10-
mongoc_uri_get_auth_source, mongoc_uri_get_auth_mechanism - access various elements of the uri
10+
mongoc_uri_get_auth_source, mongoc_uri_get_auth_mechanism,
11+
mongoc_uri_get_replica_set, mongoc_uri_get_ssl - access various elements of the uri
1112

1213

1314
SYNOPSIS
1415
--------
1516
[source,c]
1617
-----------------------
17-
const mongoc_host_list_t *mongoc_uri_get_hosts (const mongoc_uri_t *uri);
18-
const char *mongoc_uri_get_database (const mongoc_uri_t *uri);
19-
const bson_t *mongoc_uri_get_options (const mongoc_uri_t *uri);
20-
const char *mongoc_uri_get_password (const mongoc_uri_t *uri);
21-
const bson_t *mongoc_uri_get_read_prefs (const mongoc_uri_t *uri);
22-
const char *mongoc_uri_get_replica_set (const mongoc_uri_t *uri);
23-
const char *mongoc_uri_get_string (const mongoc_uri_t *uri);
24-
const char *mongoc_uri_get_username (const mongoc_uri_t *uri);
25-
const char *mongoc_uri_get_auth_source (const mongoc_uri_t *uri);
26-
const char *mongoc_uri_get_auth_mechanism (const mongoc_uri_t *uri);
18+
const mongoc_host_list_t *mongoc_uri_get_hosts (const mongoc_uri_t *);
19+
const char *mongoc_uri_get_database (const mongoc_uri_t *);
20+
const bson_t *mongoc_uri_get_options (const mongoc_uri_t *);
21+
const char *mongoc_uri_get_password (const mongoc_uri_t *);
22+
const bson_t *mongoc_uri_get_read_prefs (const mongoc_uri_t *);
23+
const char *mongoc_uri_get_replica_set (const mongoc_uri_t *);
24+
const char *mongoc_uri_get_string (const mongoc_uri_t *);
25+
const char *mongoc_uri_get_username (const mongoc_uri_t *);
26+
const char *mongoc_uri_get_auth_source (const mongoc_uri_t *);
27+
const char *mongoc_uri_get_auth_mechanism (const mongoc_uri_t *);
28+
const char *mongoc_uri_get_replica_set (const mongoc_uri_t *);
29+
bool mongoc_uri_get_ssl (const mongoc_uri_t *);
30+
const mongoc_write_concern_t *
31+
mongoc_uri_get_write_concern (const mongoc_uri_t *);
2732
-----------------------
2833

2934

doc/mongoc_uri_get_ssl.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
mongoc_uri_get_hosts.txt

doc/mongoc_uri_get_write_concern.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
mongoc_uri_get_hosts.txt

doc/mongoc_write_concern_get_fsync.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ void mongoc_write_concern_set_wtimeout (mongoc_write_concern_t *write
2626
bool mongoc_write_concern_get_wmajority (const mongoc_write_concern_t *write_concern);
2727
void mongoc_write_concern_set_wmajority (mongoc_write_concern_t *write_concern,
2828
int32_t wtimeout_msec);
29+
const char *mongoc_write_concern_get_wtag (const mongoc_write_concern_t *write_concern);
30+
void mongoc_write_concern_set_wtag (mongoc_write_concern_t *write_concern,
31+
const char *tag);
2932
-----------------------
3033

3134

0 commit comments

Comments
 (0)