.\" Man page generated from reStructuredText.
.
.TH "MONGOC_SOCKET_CONNECT" "3" "Jun 04, 2021" "1.17.6" "libmongoc"
.SH NAME
mongoc_socket_connect \- mongoc_socket_connect()
.
.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_connect (mongoc_socket_t *sock,
                       const struct sockaddr *addr,
                       mongoc_socklen_t addrlen,
                       int64_t expire_at);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBsock\fP: A \fBmongoc_socket_t\fP\&.
.IP \(bu 2
\fBaddr\fP: A struct sockaddr.
.IP \(bu 2
\fBaddrlen\fP: A mongoc_socklen_t.
.IP \(bu 2
\fBexpire_at\fP: A int64_t containing the absolute timeout using the monotonic clock.
.UNINDENT
.SH DESCRIPTION
.sp
This function is a wrapper around the BSD socket \fBconnect()\fP interface. It provides better portability between UNIX\-like and Microsoft Windows platforms.
.sp
This function performs a socket connection but will fail if \fBexpire_at\fP has been reached by the monotonic clock. Keep in mind that this is an absolute timeout in milliseconds. You should add your desired timeout to \fI\%System Clock\fP\&.
.SH RETURNS
.sp
0 if successful, \-1 on failure and errno is set.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.