1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7<title>DoHandshake</title>
8  </head>
9  <body>
10<h1><CODE>nn::ssl::Connection::DoHandshake</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">nn::Result</a> DoHandshake(
15     void
16);
17</pre>
18    </div>
19<h2>Arguments</h2>
20    <div class="section">
21<p>None.</p>
22    </div>
23<h2>Return Values</h2>
24<div class="section">Returns the processing result.<br /><br /> <br />
25      <table class="arguments">
26        <thead>
27          <tr>
28<th>Value</th>
29<td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33<th><CODE>ResultSuccess</CODE></th>
34<td>Process was successful.</td>
35        </tr>
36        <tr>
37<th>ResultProtocolFailedErr</th>
38<td>Indicates that an error occurred due to SSL protocol failure. (This can occur if client certificate authentication fails on the server side, for example.) To reconnect, first call the <a href="../../../nn/ssl/Connection/Overview.html"><CODE>Connection</CODE></a> class's <a href="../../../nn/ssl/Finalize.html"><CODE>Finalize</CODE></a> function, and then call <a href="../../../nn/ssl/Connection/Initialize.html"><CODE>Initialize</CODE></a> again.</td>
39        </tr>
40        <tr>
41<th>ResultWantRead</th>
42<td>Indicates, when an asynchronous socket was being used, that the receive function (<CODE><a href="../../../nn/socket/Read.html">nn::socket::Read</a></CODE>, etc.) returned without waiting for the operation to complete. Please try again.</td>
43        </tr>
44        <tr>
45<th>ResultWantWrite</th>
46<td>Indicates, when an asynchronous socket was being used, that the receive function (<CODE><a href="../../../nn/socket/Read.html">nn::socket::Write</a></CODE>, etc.) returned without waiting for the operation to complete. Please try again.</td>
47        </tr>
48        <tr>
49<th>ResultSystemCallErr</th>
50<td>Indicates that the library function being used internally (mostly the socket functions) returned an unexpected error. (There was an abnormal response from the server, etc.) To reconnect, first call the <a href="../../../nn/ssl/Connection/Overview.html"><CODE>Connection</CODE></a> class's <a href="../../../nn/ssl/Finalize.html"><CODE>Finalize</CODE></a> function, and then call <a href="../../../nn/ssl/Connection/Initialize.html"><CODE>Initialize</CODE></a> again.</td>
51        </tr>
52        <tr>
53<th>ResultSocketZeroReturn</th>
54<td>Indicates that the socket read/write function returned 0 (in other words, indicates that communication was aborted). To reconnect, first call the <a href="../../../nn/ssl/Connection/Overview.html"><CODE>Connection</CODE></a> class's <a href="../../../nn/ssl/Finalize.html"><CODE>Finalize</CODE></a> function, and then call <a href="../../../nn/ssl/Connection/Initialize.html"><CODE>Initialize</CODE></a> again.</td>
55        </tr>
56        <tr>
57<th>ResultWantConnect</th>
58<td>Indicates, when an asynchronous socket is being used, that the connection still has not completed. Please try again.</td>
59        </tr>
60        <tr>
61<th>ResultVerifyCertErr</th>
62<td>Indicates that certificate verification failed. (When this is returned, it is possible to get the cause of the failure with the <CODE>nn::ssl::Connection::GetCertVerifyErrors</CODE> function.) To reconnect, first call the <a href="../../../nn/ssl/Connection/Overview.html"><CODE>Connection</CODE></a> class's <a href="../../../nn/ssl/Finalize.html"><CODE>Finalize</CODE></a> function, and then call <a href="../../../nn/ssl/Connection/Initialize.html"><CODE>Initialize</CODE></a> again.</td>
63        </tr>
64        <tr>
65<th>ResultIpcSessionErr</th>
66<td>Error indicating an uninitialized connection. The function has not done anything as it has been called on a <CODE>Connection</CODE> instance for which you have not yet successfully called <a href="../../../nn/ssl/Connection/Initialize.html"><CODE>Initialize</CODE></a>.</td>
67        </tr>
68        <tr>
69<th>ResultNotInitializedErr</th>
70<td>Error indicating that the library is not initialized. None of the functions in this library can be run without first running <a href="../../../nn/ssl/Initialize.html"><CODE>nn::ssl::Initialize</CODE></a>.</td>
71        </tr>
72        <tr>
73<th>A value other than the above.</th>
74<td>Unexpected error (see <CODE>ssl_Result.h</CODE> for error details).</td>
75        </tr>
76      </table> </div>
77<h2>Description</h2>
78    <div class="section">
79<p>Performs an SSL handshake.</p>
80    </div>
81  <hr><p>CONFIDENTIAL</p></body>
82</html>
83