File tree Expand file tree Collapse file tree 2 files changed +51
-20
lines changed Expand file tree Collapse file tree 2 files changed +51
-20
lines changed Original file line number Diff line number Diff line change 1
- mongoc_stream_socket(3 )
1
+ mongoc_stream_socket(7 )
2
2
=======================
3
3
4
4
5
5
NAME
6
6
----
7
- mongoc_stream_socket_t, mongoc_stream_socket_new - create a new mongoc socket stream
7
+ mongoc_stream_socket_t - Stream IO abstraction for sockets
8
8
9
9
10
10
SYNOPSIS
11
11
--------
12
12
[source,c]
13
13
-----------------------
14
- mongoc_stream_t *mongoc_stream_socket_new (mongoc_socket_t *sock) ;
14
+ typedef struct _mongoc_stream_socket_t mongoc_stream_socket_t ;
15
15
-----------------------
16
16
17
17
18
18
DESCRIPTION
19
19
-----------
20
- The _mongoc_stream_socket_new()_ function shall create a new
21
- linkmongoc:mongoc_stream[7], taking ownership of the _mongoc_socket_t_.
22
-
23
- sock::
24
- A _mognoc_socket_t to take ownership of.
25
-
26
-
27
- RETURN VALUE
28
- ------------
29
- The _mongoc_stream_socket_new()_ shall return a new
30
- linkmongoc:mongoc_stream[7]
31
- using the provided _mongoc_socket_t_.
32
-
33
- ERRORS
34
- ------
35
- No errors are defined.
20
+ The _mongoc_stream_socket_t_ type is a subclass of _mongoc_stream_t_ for
21
+ communicating with a peer socket. It is primarily used for communicating
22
+ with a MongoDB server and should rarely need to be used directly.
36
23
37
24
38
25
SEE ALSO
39
26
--------
27
+ linkmongoc:mongoc_socket[7]
40
28
linkmongoc:mongoc_stream[7]
41
29
42
30
Load Diff This file was deleted.
Original file line number Diff line number Diff line change
1
+ mongoc_stream_socket_new(3)
2
+ ===========================
3
+
4
+
5
+ NAME
6
+ ----
7
+ mongoc_stream_socket_new - create a new mongoc stream from a socket
8
+
9
+
10
+ SYNOPSIS
11
+ --------
12
+ [source,c]
13
+ -----------------------
14
+ #include <mongoc.h>
15
+
16
+ mongoc_stream_t *mongoc_stream_socket_new (mongoc_socket_t *socket);
17
+ -----------------------
18
+
19
+
20
+ DESCRIPTION
21
+ -----------
22
+ The _mongoc_stream_socket_new()_ function shall create a new
23
+ linkmongoc:mongoc_stream[7], taking ownership of the _mongoc_socket_t_.
24
+
25
+ socket::
26
+ The _mongoc_socket_t_ for the stream to take ownership of.
27
+
28
+
29
+ RETURN VALUE
30
+ ------------
31
+ This function always returns a newly allocated mongoc_stream_t instance.
32
+ It should be freed with mongoc_stream_destroy().
33
+
34
+
35
+ SEE ALSO
36
+ --------
37
+ linkmongoc:mongoc_socket[7]
38
+ linkmongoc:mongoc_stream[7]
39
+ linkmongoc:mongoc_stream_socket[7]
40
+
41
+
42
+ AUTHORS
43
+ -------
44
+ This page was written by MongoDB, Inc.
You can’t perform that action at this time.
0 commit comments