grpc/cpp/structverify__peer__options...

155 lines
8.5 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: verify_peer_options Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">GRPC C++
&#160;<span id="projectnumber">1.31.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">verify_peer_options Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Deprecated in favor of <a class="el" href="structgrpc__ssl__verify__peer__options.html" title="Object that holds additional peer-verification options on a secure channel.">grpc_ssl_verify_peer_options</a>.
<a href="structverify__peer__options.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="grpc__security_8h_source.html">grpc_security.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:afdb80b6131d0d3775010e96efcf062a3"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structverify__peer__options.html#afdb80b6131d0d3775010e96efcf062a3">verify_peer_callback</a> )(const char *target_name, const char *peer_pem, void *userdata)</td></tr>
<tr class="memdesc:afdb80b6131d0d3775010e96efcf062a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">If non-NULL this callback will be invoked with the expected target_name, the peer's certificate (in PEM format), and whatever userdata pointer is set below. <a href="structverify__peer__options.html#afdb80b6131d0d3775010e96efcf062a3">More...</a><br /></td></tr>
<tr class="separator:afdb80b6131d0d3775010e96efcf062a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11ac6021676266d96b66538545d277cc"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structverify__peer__options.html#a11ac6021676266d96b66538545d277cc">verify_peer_callback_userdata</a></td></tr>
<tr class="memdesc:a11ac6021676266d96b66538545d277cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arbitrary userdata that will be passed as the last argument to verify_peer_callback. <a href="structverify__peer__options.html#a11ac6021676266d96b66538545d277cc">More...</a><br /></td></tr>
<tr class="separator:a11ac6021676266d96b66538545d277cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7dd670d8234469ba71e25a76f07caa68"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structverify__peer__options.html#a7dd670d8234469ba71e25a76f07caa68">verify_peer_destruct</a> )(void *userdata)</td></tr>
<tr class="memdesc:a7dd670d8234469ba71e25a76f07caa68"><td class="mdescLeft">&#160;</td><td class="mdescRight">A destruct callback that will be invoked when the channel is being cleaned up. <a href="structverify__peer__options.html#a7dd670d8234469ba71e25a76f07caa68">More...</a><br /></td></tr>
<tr class="separator:a7dd670d8234469ba71e25a76f07caa68"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Deprecated in favor of <a class="el" href="structgrpc__ssl__verify__peer__options.html" title="Object that holds additional peer-verification options on a secure channel.">grpc_ssl_verify_peer_options</a>. </p>
<p>It will be removed after all of its call sites are migrated to <a class="el" href="structgrpc__ssl__verify__peer__options.html" title="Object that holds additional peer-verification options on a secure channel.">grpc_ssl_verify_peer_options</a>. Object that holds additional peer-verification options on a secure channel. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="afdb80b6131d0d3775010e96efcf062a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdb80b6131d0d3775010e96efcf062a3">&#9670;&nbsp;</a></span>verify_peer_callback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* verify_peer_options::verify_peer_callback) (const char *target_name, const char *peer_pem, void *userdata)</td>
</tr>
</table>
</div><div class="memdoc">
<p>If non-NULL this callback will be invoked with the expected target_name, the peer's certificate (in PEM format), and whatever userdata pointer is set below. </p>
<p>If a non-zero value is returned by this callback then it is treated as a verification failure. Invocation of the callback is blocking, so any implementation should be light-weight. </p>
</div>
</div>
<a id="a11ac6021676266d96b66538545d277cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11ac6021676266d96b66538545d277cc">&#9670;&nbsp;</a></span>verify_peer_callback_userdata</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* verify_peer_options::verify_peer_callback_userdata</td>
</tr>
</table>
</div><div class="memdoc">
<p>Arbitrary userdata that will be passed as the last argument to verify_peer_callback. </p>
</div>
</div>
<a id="a7dd670d8234469ba71e25a76f07caa68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7dd670d8234469ba71e25a76f07caa68">&#9670;&nbsp;</a></span>verify_peer_destruct</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* verify_peer_options::verify_peer_destruct) (void *userdata)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A destruct callback that will be invoked when the channel is being cleaned up. </p>
<p>The userdata argument will be passed to it. The intent is to perform any cleanup associated with that userdata. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/grpc/<a class="el" href="grpc__security_8h_source.html">grpc_security.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Aug 18 2020 16:24:48 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>