| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>GRPC C++: include/grpcpp/impl/codegen/client_interceptor.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 style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">GRPC C++
-  <span id="projectnumber">1.23.0</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.13 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- </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 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_412f9a3d5dfcba8716486cd870ef4586.html">grpcpp</a></li><li class="navelem"><a class="el" href="dir_84040d6f573b73aa8d12512b533ede11.html">impl</a></li><li class="navelem"><a class="el" href="dir_a33e3e3a3b205cffecbb359564791f71.html">codegen</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="headertitle">
- <div class="title">client_interceptor.h</div> </div>
- </div><!--header-->
- <div class="contents">
- <a href="impl_2codegen_2client__interceptor_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2018 gRPC authors.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> */</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef GRPCPP_IMPL_CODEGEN_CLIENT_INTERCEPTOR_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define GRPCPP_IMPL_CODEGEN_CLIENT_INTERCEPTOR_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="code" href="impl_2codegen_2interceptor_8h.html">grpcpp/impl/codegen/interceptor.h</a>></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="grpcpp_2impl_2codegen_2rpc__method_8h.html">grpcpp/impl/codegen/rpc_method.h</a>></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="grpcpp_2impl_2codegen_2string__ref_8h.html">grpcpp/impl/codegen/string_ref.h</a>></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span><a class="code" href="namespacegrpc__impl.html">grpc_impl</a> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span><a class="code" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">Channel</a>;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span><a class="code" href="namespacegrpc.html#a35a61e2e00942ae1f40dda77413425ac">ClientContext</a>;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> } <span class="comment">// namespace grpc_impl</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span><a class="code" href="namespacegrpc.html">grpc</a> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">namespace </span>internal {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>InterceptorBatchMethodsImpl;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> }</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">namespace </span>experimental {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">class </span>ClientRpcInfo;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// A factory interface for creation of client interceptors. A vector of</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">// factories can be provided at channel creation which will be used to create a</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// new vector of client interceptors per RPC. Client interceptor authors should</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// create a subclass of ClientInterceptorFactorInterface which creates objects</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// of their interceptors.</span></div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html"> 49</a></span> <span class="keyword">class </span><a class="code" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html">ClientInterceptorFactoryInterface</a> {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html#a92ae3f8645616648bd9a78e1de12709a"> 51</a></span>  <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html#a92ae3f8645616648bd9a78e1de12709a">~ClientInterceptorFactoryInterface</a>() {}</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// Returns a pointer to an Interceptor object on successful creation, nullptr</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// otherwise. If nullptr is returned, this server interceptor factory is</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// ignored for the purposes of that RPC.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1experimental_1_1_interceptor.html">Interceptor</a>* CreateClientInterceptor(<a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html">ClientRpcInfo</a>* info) = 0;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> };</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> } <span class="comment">// namespace experimental</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">namespace </span>internal {</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">extern</span> <a class="code" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html">experimental::ClientInterceptorFactoryInterface</a>*</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="namespacegrpc_1_1internal.html#a6d0efed83b2ed7bd6f5b07e44ea3689e">g_global_client_interceptor_factory</a>;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> }</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">namespace </span>experimental {</div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_client_rpc_info.html"> 69</a></span> <span class="keyword">class </span><a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html">ClientRpcInfo</a> {</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">// TODO(yashykt): Stop default-constructing ClientRpcInfo and remove UNKNOWN</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// from the list of possible Types.</span></div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_client_rpc_info.html#afe1e51b91fd4805bf77fdb85d007ca2c"> 74</a></span> <span class="comment"></span> <span class="keyword">enum class</span> <a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html#afe1e51b91fd4805bf77fdb85d007ca2c">Type</a> {</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  UNARY,</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  CLIENT_STREAMING,</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  SERVER_STREAMING,</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  BIDI_STREAMING,</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <a class="code" href="namespacegrpc.html#aff1730578c90160528f6a8d67ef5c43bab32b226dd4ccbe5b70fbceb3a915b256">UNKNOWN</a> <span class="comment">// UNKNOWN is not API and will be removed later</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  };</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_client_rpc_info.html#aaa5738d4ea450532ecfc52216cf27fcb"> 82</a></span>  <a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html#aaa5738d4ea450532ecfc52216cf27fcb">~ClientRpcInfo</a>() {}</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">// Delete copy constructor but allow default move constructor</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html">ClientRpcInfo</a>(<span class="keyword">const</span> <a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html">ClientRpcInfo</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html">ClientRpcInfo</a>(<a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html">ClientRpcInfo</a>&&) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="comment">// Getter methods</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_client_rpc_info.html#a9a4ae8b85a692a5baf72f6aafae2e097"> 91</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html#a9a4ae8b85a692a5baf72f6aafae2e097">method</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> method_; }</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_client_rpc_info.html#a7eb6bb8ce31c8f9be44b8dab1d1a6d27"> 94</a></span>  <a class="code" href="classgrpc_1_1_channel_interface.html">ChannelInterface</a>* <a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html#a7eb6bb8ce31c8f9be44b8dab1d1a6d27">channel</a>() { <span class="keywordflow">return</span> channel_; }</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_client_rpc_info.html#ae693b79e5b146e1a906c5857b0e576ff"> 98</a></span>  <a class="code" href="classgrpc__impl_1_1_client_context.html">grpc_impl::ClientContext</a>* <a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html#ae693b79e5b146e1a906c5857b0e576ff">client_context</a>() { <span class="keywordflow">return</span> ctx_; }</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_client_rpc_info.html#a6d97a409fc9d22ec20ede8e1b9bc11c9"> 101</a></span>  <a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html#afe1e51b91fd4805bf77fdb85d007ca2c">Type</a> <a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html#a6d97a409fc9d22ec20ede8e1b9bc11c9">type</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> type_; }</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  static_assert(Type::UNARY ==</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  static_cast<Type>(internal::RpcMethod::NORMAL_RPC),</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="stringliteral">"violated expectation about Type enum"</span>);</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  static_assert(Type::CLIENT_STREAMING ==</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  static_cast<Type>(internal::RpcMethod::CLIENT_STREAMING),</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="stringliteral">"violated expectation about Type enum"</span>);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  static_assert(Type::SERVER_STREAMING ==</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  static_cast<Type>(internal::RpcMethod::SERVER_STREAMING),</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="stringliteral">"violated expectation about Type enum"</span>);</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  static_assert(Type::BIDI_STREAMING ==</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  static_cast<Type>(internal::RpcMethod::BIDI_STREAMING),</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="stringliteral">"violated expectation about Type enum"</span>);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="comment">// Default constructor should only be used by ClientContext</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html">ClientRpcInfo</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="comment">// Constructor will only be called from ClientContext</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html">ClientRpcInfo</a>(<a class="code" href="classgrpc__impl_1_1_client_context.html">grpc_impl::ClientContext</a>* ctx,</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <a class="code" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">internal::RpcMethod::RpcType</a> type, <span class="keyword">const</span> <span class="keywordtype">char</span>* method,</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <a class="code" href="classgrpc_1_1_channel_interface.html">grpc::ChannelInterface</a>* channel)</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  : ctx_(ctx),</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  type_(static_cast<Type>(type)),</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  method_(method),</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  channel_(channel) {}</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="comment">// Move assignment should only be used by ClientContext</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="comment">// TODO(yashykt): Delete move assignment</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html">ClientRpcInfo</a>& operator=(<a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html">ClientRpcInfo</a>&&) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="comment">// Runs interceptor at pos \a pos.</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordtype">void</span> RunInterceptor(</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <a class="code" href="classgrpc_1_1experimental_1_1_interceptor_batch_methods.html">experimental::InterceptorBatchMethods</a>* interceptor_methods, <span class="keywordtype">size_t</span> pos) {</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <a class="code" href="grpcpp_2impl_2codegen_2core__codegen__interface_8h.html#a39c1421e7081b57c503487659e2653a5">GPR_CODEGEN_ASSERT</a>(pos < interceptors_.size());</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  interceptors_[pos]->Intercept(interceptor_methods);</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  }</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keywordtype">void</span> RegisterInterceptors(</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keyword">const</span> std::vector<std::unique_ptr<</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <a class="code" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html">experimental::ClientInterceptorFactoryInterface</a>>>& creators,</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordtype">size_t</span> interceptor_pos) {</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keywordflow">if</span> (interceptor_pos > creators.size()) {</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="comment">// No interceptors to register</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keywordflow">return</span>;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  }</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span> it = creators.begin() + interceptor_pos; it != creators.end();</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  ++it) {</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keyword">auto</span>* interceptor = (*it)->CreateClientInterceptor(<span class="keyword">this</span>);</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keywordflow">if</span> (interceptor != <span class="keyword">nullptr</span>) {</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  interceptors_.push_back(</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  std::unique_ptr<experimental::Interceptor>(interceptor));</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  }</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  }</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordflow">if</span> (<a class="code" href="namespacegrpc_1_1internal.html#a6d0efed83b2ed7bd6f5b07e44ea3689e">internal::g_global_client_interceptor_factory</a> != <span class="keyword">nullptr</span>) {</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  interceptors_.push_back(std::unique_ptr<experimental::Interceptor>(</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <a class="code" href="namespacegrpc_1_1internal.html#a6d0efed83b2ed7bd6f5b07e44ea3689e">internal::g_global_client_interceptor_factory</a></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  ->CreateClientInterceptor(<span class="keyword">this</span>)));</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  }</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  }</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <a class="code" href="classgrpc__impl_1_1_client_context.html">grpc_impl::ClientContext</a>* ctx_ = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="comment">// TODO(yashykt): make type_ const once move-assignment is deleted</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <a class="code" href="classgrpc_1_1experimental_1_1_client_rpc_info.html#afe1e51b91fd4805bf77fdb85d007ca2c">Type</a> type_{<a class="code" href="namespacegrpc.html#aff1730578c90160528f6a8d67ef5c43bab32b226dd4ccbe5b70fbceb3a915b256">Type::UNKNOWN</a>};</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* method_ = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <a class="code" href="classgrpc_1_1_channel_interface.html">grpc::ChannelInterface</a>* channel_ = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  std::vector<std::unique_ptr<experimental::Interceptor>> interceptors_;</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keywordtype">bool</span> hijacked_ = <span class="keyword">false</span>;</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keywordtype">size_t</span> hijacked_interceptor_ = 0;</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div><div class="line"><a name="l00172"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_client_rpc_info.html#a92d0ab83566677bbb964bef133221b67"> 172</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classgrpc_1_1internal_1_1_interceptor_batch_methods_impl.html">internal::InterceptorBatchMethodsImpl</a>;</div><div class="line"><a name="l00173"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_client_rpc_info.html#a1e23749cae35087c44426b189e452a47"> 173</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classgrpc__impl_1_1_client_context.html">grpc_impl::ClientContext</a>;</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> };</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment">// PLEASE DO NOT USE THIS. ALWAYS PREFER PER CHANNEL INTERCEPTORS OVER A GLOBAL</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment">// INTERCEPTOR. IF USAGE IS ABSOLUTELY NECESSARY, PLEASE READ THE SAFETY NOTES.</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment">// Registers a global client interceptor factory object, which is used for all</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment">// RPCs made in this process. The application is responsible for maintaining the</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment">// life of the object while gRPC operations are in progress. The global</span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment">// interceptor factory should only be registered once at the start of the</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment">// process before any gRPC operations have begun.</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="keywordtype">void</span> <a class="code" href="namespacegrpc_1_1experimental.html#abf863776469f08e69e7ca6e82246fd7a">RegisterGlobalClientInterceptorFactory</a>(</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <a class="code" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html">ClientInterceptorFactoryInterface</a>* factory);</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment">// For testing purposes only</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="keywordtype">void</span> <a class="code" href="namespacegrpc_1_1experimental.html#a06e8ad17f59ec479769f014e79a4b068">TestOnlyResetGlobalClientInterceptorFactory</a>();</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> </div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> } <span class="comment">// namespace experimental</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> } <span class="comment">// namespace grpc</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="preprocessor">#endif // GRPCPP_IMPL_CODEGEN_CLIENT_INTERCEPTOR_H</span></div><div class="ttc" id="namespacegrpc_html_a35a61e2e00942ae1f40dda77413425ac"><div class="ttname"><a href="namespacegrpc.html#a35a61e2e00942ae1f40dda77413425ac">grpc::ClientContext</a></div><div class="ttdeci">::grpc_impl::ClientContext ClientContext</div><div class="ttdef"><b>Definition:</b> client_context.h:26</div></div>
- <div class="ttc" id="grpcpp_2impl_2codegen_2core__codegen__interface_8h_html_a39c1421e7081b57c503487659e2653a5"><div class="ttname"><a href="grpcpp_2impl_2codegen_2core__codegen__interface_8h.html#a39c1421e7081b57c503487659e2653a5">GPR_CODEGEN_ASSERT</a></div><div class="ttdeci">#define GPR_CODEGEN_ASSERT(x)</div><div class="ttdoc">Codegen specific version of GPR_ASSERT. </div><div class="ttdef"><b>Definition:</b> core_codegen_interface.h:145</div></div>
- <div class="ttc" id="classgrpc_1_1experimental_1_1_interceptor_batch_methods_html"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_interceptor_batch_methods.html">grpc::experimental::InterceptorBatchMethods</a></div><div class="ttdoc">Class that is passed as an argument to the Intercept method of the application&#39;s Interceptor interfac...</div><div class="ttdef"><b>Definition:</b> interceptor.h:91</div></div>
- <div class="ttc" id="classgrpc_1_1experimental_1_1_client_rpc_info_html_aaa5738d4ea450532ecfc52216cf27fcb"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_client_rpc_info.html#aaa5738d4ea450532ecfc52216cf27fcb">grpc::experimental::ClientRpcInfo::~ClientRpcInfo</a></div><div class="ttdeci">~ClientRpcInfo()</div><div class="ttdef"><b>Definition:</b> client_interceptor.h:82</div></div>
- <div class="ttc" id="namespacegrpc_1_1experimental_html_abf863776469f08e69e7ca6e82246fd7a"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#abf863776469f08e69e7ca6e82246fd7a">grpc::experimental::RegisterGlobalClientInterceptorFactory</a></div><div class="ttdeci">void RegisterGlobalClientInterceptorFactory(ClientInterceptorFactoryInterface *factory)</div></div>
- <div class="ttc" id="grpcpp_2impl_2codegen_2string__ref_8h_html"><div class="ttname"><a href="grpcpp_2impl_2codegen_2string__ref_8h.html">string_ref.h</a></div></div>
- <div class="ttc" id="grpcpp_2impl_2codegen_2rpc__method_8h_html"><div class="ttname"><a href="grpcpp_2impl_2codegen_2rpc__method_8h.html">rpc_method.h</a></div></div>
- <div class="ttc" id="classgrpc_1_1experimental_1_1_client_rpc_info_html_a7eb6bb8ce31c8f9be44b8dab1d1a6d27"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_client_rpc_info.html#a7eb6bb8ce31c8f9be44b8dab1d1a6d27">grpc::experimental::ClientRpcInfo::channel</a></div><div class="ttdeci">ChannelInterface * channel()</div><div class="ttdoc">Return a pointer to the channel on which the RPC is being sent. </div><div class="ttdef"><b>Definition:</b> client_interceptor.h:94</div></div>
- <div class="ttc" id="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface_html_a92ae3f8645616648bd9a78e1de12709a"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html#a92ae3f8645616648bd9a78e1de12709a">grpc::experimental::ClientInterceptorFactoryInterface::~ClientInterceptorFactoryInterface</a></div><div class="ttdeci">virtual ~ClientInterceptorFactoryInterface()</div><div class="ttdef"><b>Definition:</b> client_interceptor.h:51</div></div>
- <div class="ttc" id="classgrpc_1_1internal_1_1_rpc_method_html_a40ce84e3569f6a327468ae59f04c7dd1"><div class="ttname"><a href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">grpc::internal::RpcMethod::RpcType</a></div><div class="ttdeci">RpcType</div><div class="ttdef"><b>Definition:</b> rpc_method.h:31</div></div>
- <div class="ttc" id="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface_html"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html">grpc::experimental::ClientInterceptorFactoryInterface</a></div><div class="ttdef"><b>Definition:</b> client_interceptor.h:49</div></div>
- <div class="ttc" id="classgrpc_1_1experimental_1_1_client_rpc_info_html_a6d97a409fc9d22ec20ede8e1b9bc11c9"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_client_rpc_info.html#a6d97a409fc9d22ec20ede8e1b9bc11c9">grpc::experimental::ClientRpcInfo::type</a></div><div class="ttdeci">Type type() const</div><div class="ttdoc">Return the type of the RPC (unary or a streaming flavor) </div><div class="ttdef"><b>Definition:</b> client_interceptor.h:101</div></div>
- <div class="ttc" id="namespacegrpc_html_a3c981ec4941ef822eb01ac99da53ca88"><div class="ttname"><a href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a></div><div class="ttdeci">::grpc_impl::Channel Channel</div><div class="ttdef"><b>Definition:</b> channel.h:26</div></div>
- <div class="ttc" id="classgrpc_1_1experimental_1_1_client_rpc_info_html_a9a4ae8b85a692a5baf72f6aafae2e097"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_client_rpc_info.html#a9a4ae8b85a692a5baf72f6aafae2e097">grpc::experimental::ClientRpcInfo::method</a></div><div class="ttdeci">const char * method() const</div><div class="ttdoc">Return the fully-specified method name. </div><div class="ttdef"><b>Definition:</b> client_interceptor.h:91</div></div>
- <div class="ttc" id="impl_2codegen_2interceptor_8h_html"><div class="ttname"><a href="impl_2codegen_2interceptor_8h.html">interceptor.h</a></div></div>
- <div class="ttc" id="namespacegrpc_html"><div class="ttname"><a href="namespacegrpc.html">grpc</a></div><div class="ttdoc">This header provides an object that reads bytes directly from a grpc::ByteBuffer, via the ZeroCopyInp...</div><div class="ttdef"><b>Definition:</b> alarm.h:24</div></div>
- <div class="ttc" id="classgrpc_1_1experimental_1_1_interceptor_html"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_interceptor.html">grpc::experimental::Interceptor</a></div><div class="ttdoc">Interface for an interceptor. </div><div class="ttdef"><b>Definition:</b> interceptor.h:215</div></div>
- <div class="ttc" id="classgrpc_1_1_channel_interface_html"><div class="ttname"><a href="classgrpc_1_1_channel_interface.html">grpc::ChannelInterface</a></div><div class="ttdoc">Codegen interface for grpc::Channel. </div><div class="ttdef"><b>Definition:</b> channel_interface.h:70</div></div>
- <div class="ttc" id="classgrpc_1_1internal_1_1_interceptor_batch_methods_impl_html"><div class="ttname"><a href="classgrpc_1_1internal_1_1_interceptor_batch_methods_impl.html">grpc::internal::InterceptorBatchMethodsImpl</a></div><div class="ttdef"><b>Definition:</b> interceptor_common.h:36</div></div>
- <div class="ttc" id="namespacegrpc__impl_html"><div class="ttname"><a href="namespacegrpc__impl.html">grpc_impl</a></div><div class="ttdoc">An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...</div><div class="ttdef"><b>Definition:</b> alarm_impl.h:33</div></div>
- <div class="ttc" id="namespacegrpc_1_1experimental_html_a06e8ad17f59ec479769f014e79a4b068"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#a06e8ad17f59ec479769f014e79a4b068">grpc::experimental::TestOnlyResetGlobalClientInterceptorFactory</a></div><div class="ttdeci">void TestOnlyResetGlobalClientInterceptorFactory()</div></div>
- <div class="ttc" id="namespacegrpc_1_1internal_html_a6d0efed83b2ed7bd6f5b07e44ea3689e"><div class="ttname"><a href="namespacegrpc_1_1internal.html#a6d0efed83b2ed7bd6f5b07e44ea3689e">grpc::internal::g_global_client_interceptor_factory</a></div><div class="ttdeci">experimental::ClientInterceptorFactoryInterface * g_global_client_interceptor_factory</div></div>
- <div class="ttc" id="classgrpc__impl_1_1_client_context_html"><div class="ttname"><a href="classgrpc__impl_1_1_client_context.html">grpc_impl::ClientContext</a></div><div class="ttdoc">A ClientContext allows the person implementing a service client to: </div><div class="ttdef"><b>Definition:</b> client_context_impl.h:180</div></div>
- <div class="ttc" id="classgrpc_1_1experimental_1_1_client_rpc_info_html_ae693b79e5b146e1a906c5857b0e576ff"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_client_rpc_info.html#ae693b79e5b146e1a906c5857b0e576ff">grpc::experimental::ClientRpcInfo::client_context</a></div><div class="ttdeci">grpc_impl::ClientContext * client_context()</div><div class="ttdoc">Return a pointer to the underlying ClientContext structure associated with the RPC to support feature...</div><div class="ttdef"><b>Definition:</b> client_interceptor.h:98</div></div>
- <div class="ttc" id="namespacegrpc_html_aff1730578c90160528f6a8d67ef5c43bab32b226dd4ccbe5b70fbceb3a915b256"><div class="ttname"><a href="namespacegrpc.html#aff1730578c90160528f6a8d67ef5c43bab32b226dd4ccbe5b70fbceb3a915b256">grpc::UNKNOWN</a></div><div class="ttdoc">Unknown error. </div><div class="ttdef"><b>Definition:</b> status_code_enum.h:35</div></div>
- <div class="ttc" id="classgrpc_1_1experimental_1_1_client_rpc_info_html_afe1e51b91fd4805bf77fdb85d007ca2c"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_client_rpc_info.html#afe1e51b91fd4805bf77fdb85d007ca2c">grpc::experimental::ClientRpcInfo::Type</a></div><div class="ttdeci">Type</div><div class="ttdoc">Type categorizes RPCs by unary or streaming type. </div><div class="ttdef"><b>Definition:</b> client_interceptor.h:74</div></div>
- <div class="ttc" id="classgrpc_1_1experimental_1_1_client_rpc_info_html"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_client_rpc_info.html">grpc::experimental::ClientRpcInfo</a></div><div class="ttdef"><b>Definition:</b> client_interceptor.h:69</div></div>
- </div><!-- fragment --></div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Mon Aug 19 2019 12:05:23 for GRPC C++ by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.13
- </small></address>
- </body>
- </html>
|
