.\" Man page generated from reStructuredText.
.
.TH "MONGOC_SOCKET_CLOSE" "3" "Jun 04, 2021" "1.17.6" "libmongoc"
.SH NAME
mongoc_socket_close \- mongoc_socket_close()
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
int
mongoc_socket_close (mongoc_socket_t *socket);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBsocket\fP: A \fBmongoc_socket_t\fP\&.
.UNINDENT
.SH DESCRIPTION
.sp
This function is a wrapper around the BSD socket \fBshutdown()\fP and \fBclose()\fP functions, and their Windows equivalents. The socket is shut down only if the current process is the same as the process that opened the socket. Regardless, the socket is then closed.
.SH RETURNS
.sp
0 on success, \-1 on failure to close the socket. On failure, the socket\(aqs errno is set; retrieve it with \fBmongoc_socket_errno()\fP\&.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.