-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy path_bootstrap_8h_source.html
165 lines (163 loc) · 19 KB
/
_bootstrap_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>aws-crt-cpp: include/aws/crt/io/Bootstrap.h Source File</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 id="projectrow">
<td id="projectalign">
<div id="projectname">aws-crt-cpp
</div>
<div id="projectbrief">C++ wrapper around the aws-c-* libraries. Provides Cross-Platform Transport Protocols and SSL/TLS implementations for C++.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_076842b242c291358044feb169933571.html">aws</a></li><li class="navelem"><a class="el" href="dir_cc4322e4b2151c90adb7cd2e3f54423a.html">crt</a></li><li class="navelem"><a class="el" href="dir_b90b4e231cf9df4b6b8451850277e486.html">io</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Bootstrap.h</div></div>
</div><!--header-->
<div class="contents">
<a href="_bootstrap_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include <<a class="code" href="_exports_8h.html">aws/crt/Exports.h</a>></span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include <<a class="code" href="_types_8h.html">aws/crt/Types.h</a>></span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <<a class="code" href="_event_loop_group_8h.html">aws/crt/io/EventLoopGroup.h</a>></span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include <<a class="code" href="_host_resolver_8h.html">aws/crt/io/HostResolver.h</a>></span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include <aws/io/channel_bootstrap.h></span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include <aws/io/host_resolver.h></span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include <future></span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_aws.html">Aws</a></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>{</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">namespace </span>Crt</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> {</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span>Io</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> {</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="namespace_aws_1_1_crt_1_1_io.html#a3284b8b9a955c2b24fd3d095350f22e1"> 23</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="namespace_aws_1_1_crt_1_1_io.html#a3284b8b9a955c2b24fd3d095350f22e1">OnClientBootstrapShutdownComplete</a> = std::function<void()>;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="foldopen" id="foldopen00034" data-start="{" data-end="};">
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html"> 34</a></span> <span class="keyword">class </span><a class="code hl_define" href="_exports_8h.html#a0a3f6c46aee6b588ce99a142cdb22d1d">AWS_CRT_CPP_API</a> <a class="code hl_class" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html">ClientBootstrap</a> final</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_class" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html">ClientBootstrap</a>(</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <a class="code hl_class" href="class_aws_1_1_crt_1_1_io_1_1_event_loop_group.html">EventLoopGroup</a> &elGroup,</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_class" href="class_aws_1_1_crt_1_1_io_1_1_host_resolver.html">HostResolver</a> &resolver,</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_typedef" href="namespace_aws_1_1_crt.html#a3df51ca65ad8c873825aacd24abba5f5">Allocator</a> *allocator = <a class="code hl_function" href="namespace_aws_1_1_crt.html#a47fd6342e28c4e66e4637a404153918a">ApiAllocator</a>()) <span class="keyword">noexcept</span>;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <a class="code hl_class" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html">ClientBootstrap</a>(<a class="code hl_typedef" href="namespace_aws_1_1_crt.html#a3df51ca65ad8c873825aacd24abba5f5">Allocator</a> *allocator = <a class="code hl_function" href="namespace_aws_1_1_crt.html#a47fd6342e28c4e66e4637a404153918a">ApiAllocator</a>()) <span class="keyword">noexcept</span>;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <a class="code hl_class" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html">~ClientBootstrap</a>();</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html#ac6669a24157928a6182dce6fbd0ed87e"> 55</a></span> <a class="code hl_function" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html#ac6669a24157928a6182dce6fbd0ed87e">ClientBootstrap</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html">ClientBootstrap</a> &) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html#ac81f9bb807548c448700f47604b92ad3"> 56</a></span> <a class="code hl_class" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html">ClientBootstrap</a> &<a class="code hl_function" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html#ac81f9bb807548c448700f47604b92ad3">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html">ClientBootstrap</a> &) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html#a615bc843746ff0c53ffef5cc71b8f935"> 57</a></span> <a class="code hl_function" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html#a615bc843746ff0c53ffef5cc71b8f935">ClientBootstrap</a>(<a class="code hl_class" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html">ClientBootstrap</a> &&) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html#ab9ed6ec281120a1fe15bf7c7bb0e52a6"> 58</a></span> <a class="code hl_class" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html">ClientBootstrap</a> &<a class="code hl_function" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html#ab9ed6ec281120a1fe15bf7c7bb0e52a6">operator=</a>(<a class="code hl_class" href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html">ClientBootstrap</a> &&) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">operator</span> bool() const noexcept;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keywordtype">int</span> LastError() const noexcept;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keywordtype">void</span> SetShutdownCompleteCallback(<a class="code hl_typedef" href="namespace_aws_1_1_crt_1_1_io.html#a3284b8b9a955c2b24fd3d095350f22e1">OnClientBootstrapShutdownComplete</a> callback);</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keywordtype">void</span> EnableBlockingShutdown() noexcept;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> aws_client_bootstrap *GetUnderlyingHandle() const noexcept;</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> private:</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> aws_client_bootstrap *m_bootstrap;</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keywordtype">int</span> m_lastError;</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <a class="code hl_namespace" href="namespacestd.html">std</a>::unique_ptr<class ClientBootstrapCallbackData> m_callbackData;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <a class="code hl_namespace" href="namespacestd.html">std</a>::future<<span class="keywordtype">void</span>> m_shutdownFuture;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keywordtype">bool</span> m_enableBlockingShutdown;</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> };</div>
</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> } <span class="comment">// namespace Io</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> } <span class="comment">// namespace Crt</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span>} <span class="comment">// namespace Aws</span></div>
<div class="ttc" id="a_event_loop_group_8h_html"><div class="ttname"><a href="_event_loop_group_8h.html">EventLoopGroup.h</a></div></div>
<div class="ttc" id="a_exports_8h_html"><div class="ttname"><a href="_exports_8h.html">Exports.h</a></div></div>
<div class="ttc" id="a_exports_8h_html_a0a3f6c46aee6b588ce99a142cdb22d1d"><div class="ttname"><a href="_exports_8h.html#a0a3f6c46aee6b588ce99a142cdb22d1d">AWS_CRT_CPP_API</a></div><div class="ttdeci">#define AWS_CRT_CPP_API</div><div class="ttdef"><b>Definition</b> Exports.h:36</div></div>
<div class="ttc" id="a_host_resolver_8h_html"><div class="ttname"><a href="_host_resolver_8h.html">HostResolver.h</a></div></div>
<div class="ttc" id="a_types_8h_html"><div class="ttname"><a href="_types_8h.html">Types.h</a></div></div>
<div class="ttc" id="aclass_aws_1_1_crt_1_1_io_1_1_client_bootstrap_html"><div class="ttname"><a href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html">Aws::Crt::Io::ClientBootstrap</a></div><div class="ttdef"><b>Definition</b> Bootstrap.h:35</div></div>
<div class="ttc" id="aclass_aws_1_1_crt_1_1_io_1_1_client_bootstrap_html_a615bc843746ff0c53ffef5cc71b8f935"><div class="ttname"><a href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html#a615bc843746ff0c53ffef5cc71b8f935">Aws::Crt::Io::ClientBootstrap::ClientBootstrap</a></div><div class="ttdeci">ClientBootstrap(ClientBootstrap &&)=delete</div></div>
<div class="ttc" id="aclass_aws_1_1_crt_1_1_io_1_1_client_bootstrap_html_ab9ed6ec281120a1fe15bf7c7bb0e52a6"><div class="ttname"><a href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html#ab9ed6ec281120a1fe15bf7c7bb0e52a6">Aws::Crt::Io::ClientBootstrap::operator=</a></div><div class="ttdeci">ClientBootstrap & operator=(ClientBootstrap &&)=delete</div></div>
<div class="ttc" id="aclass_aws_1_1_crt_1_1_io_1_1_client_bootstrap_html_ac6669a24157928a6182dce6fbd0ed87e"><div class="ttname"><a href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html#ac6669a24157928a6182dce6fbd0ed87e">Aws::Crt::Io::ClientBootstrap::ClientBootstrap</a></div><div class="ttdeci">ClientBootstrap(const ClientBootstrap &)=delete</div></div>
<div class="ttc" id="aclass_aws_1_1_crt_1_1_io_1_1_client_bootstrap_html_ac81f9bb807548c448700f47604b92ad3"><div class="ttname"><a href="class_aws_1_1_crt_1_1_io_1_1_client_bootstrap.html#ac81f9bb807548c448700f47604b92ad3">Aws::Crt::Io::ClientBootstrap::operator=</a></div><div class="ttdeci">ClientBootstrap & operator=(const ClientBootstrap &)=delete</div></div>
<div class="ttc" id="aclass_aws_1_1_crt_1_1_io_1_1_event_loop_group_html"><div class="ttname"><a href="class_aws_1_1_crt_1_1_io_1_1_event_loop_group.html">Aws::Crt::Io::EventLoopGroup</a></div><div class="ttdef"><b>Definition</b> EventLoopGroup.h:33</div></div>
<div class="ttc" id="aclass_aws_1_1_crt_1_1_io_1_1_host_resolver_html"><div class="ttname"><a href="class_aws_1_1_crt_1_1_io_1_1_host_resolver.html">Aws::Crt::Io::HostResolver</a></div><div class="ttdef"><b>Definition</b> HostResolver.h:35</div></div>
<div class="ttc" id="anamespace_aws_1_1_crt_1_1_io_html_a3284b8b9a955c2b24fd3d095350f22e1"><div class="ttname"><a href="namespace_aws_1_1_crt_1_1_io.html#a3284b8b9a955c2b24fd3d095350f22e1">Aws::Crt::Io::OnClientBootstrapShutdownComplete</a></div><div class="ttdeci">std::function< void()> OnClientBootstrapShutdownComplete</div><div class="ttdef"><b>Definition</b> Bootstrap.h:23</div></div>
<div class="ttc" id="anamespace_aws_1_1_crt_html_a3df51ca65ad8c873825aacd24abba5f5"><div class="ttname"><a href="namespace_aws_1_1_crt.html#a3df51ca65ad8c873825aacd24abba5f5">Aws::Crt::Allocator</a></div><div class="ttdeci">aws_allocator Allocator</div><div class="ttdef"><b>Definition</b> Allocator.h:14</div></div>
<div class="ttc" id="anamespace_aws_1_1_crt_html_a47fd6342e28c4e66e4637a404153918a"><div class="ttname"><a href="namespace_aws_1_1_crt.html#a47fd6342e28c4e66e4637a404153918a">Aws::Crt::ApiAllocator</a></div><div class="ttdeci">AWS_CRT_CPP_API Allocator * ApiAllocator() noexcept</div><div class="ttdef"><b>Definition</b> Allocator.cpp:24</div></div>
<div class="ttc" id="anamespace_aws_html"><div class="ttname"><a href="namespace_aws.html">Aws</a></div><div class="ttdef"><b>Definition</b> Allocator.h:11</div></div>
<div class="ttc" id="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdef"><b>Definition</b> StringView.h:862</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>