.\" This manpage is Copyright (C) 2016 MongoDB, Inc.
.\" 
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.3
.\" or any later version published by the Free Software Foundation;
.\" with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
.\" A copy of the license is included in the section entitled "GNU
.\" Free Documentation License".
.\" 
.TH "MONGOC_STREAM_TLS_DO_HANDSHAKE" "3" "2016\(hy10\(hy12" "MongoDB C Driver"
.SH NAME
mongoc_stream_tls_do_handshake() \- This function shall perform an SSL handshake on the underlying stream.
.SH "SYNOPSIS"

.nf
.nf
bool
mongoc_stream_tls_do_handshake (mongoc_stream_t *stream,
                                int32_t          timeout_msec);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
stream
A
.B mongoc_stream_tls_t
.
.LP
.TP
.B
timeout_msec
A timeout, in milliseconds, for the handshake.
.LP

This function shall perform an SSL handshake on the underlying stream.

.SH "RETURNS"

The
.B mongoc_stream_tls_do_handshake(3)
function returns true if the handshake was successful. If false, errno or openssl errors may be set.


.B
.SH COLOPHON
This page is part of MongoDB C Driver.
Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.