carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
							<!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/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++
   &#160;<span id="projectnumber">1.17.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">interceptor.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="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>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * Copyright 2018 gRPC authors.</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<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>&#160;<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>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<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>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<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>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<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>&#160;<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>&#160;<span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#ifndef GRPCPP_IMPL_CODEGEN_INTERCEPTOR_H</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#define GRPCPP_IMPL_CODEGEN_INTERCEPTOR_H</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpc__types_8h.html">grpc/impl/codegen/grpc_types.h</a>&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2impl_2codegen_2byte__buffer_8h.html">grpcpp/impl/codegen/byte_buffer.h</a>&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2impl_2codegen_2config_8h.html">grpcpp/impl/codegen/config.h</a>&gt;</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2impl_2codegen_2core__codegen__interface_8h.html">grpcpp/impl/codegen/core_codegen_interface.h</a>&gt;</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2impl_2codegen_2metadata__map_8h.html">grpcpp/impl/codegen/metadata_map.h</a>&gt;</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrpc.html">grpc</a> {</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">class </span>ChannelInterface;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="keyword">class </span><a class="code" href="namespacegrpc_1_1protobuf_1_1util.html#a717f1a5db6c98d3f27340afd6f28bf7e">Status</a>;</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="keyword">namespace </span>experimental {</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_intercepted_message.html">   34</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1experimental_1_1_intercepted_message.html">InterceptedMessage</a> {</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;  <span class="keyword">template</span> &lt;<span class="keyword">class</span> M&gt;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;  <span class="keywordtype">bool</span> <a class="code" href="classgrpc_1_1experimental_1_1_intercepted_message.html#aa0cb07e93e88b059e578e01533c396cb">Extract</a>(M* msg);  <span class="comment">// returns false if definitely invalid extraction</span></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;  <span class="keyword">template</span> &lt;<span class="keyword">class</span> M&gt;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;  M* <a class="code" href="classgrpc_1_1experimental_1_1_intercepted_message.html#a526fc46bb5b14ce05e7f717928c46a41">MutableExtract</a>();</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;  uint64_t <a class="code" href="classgrpc_1_1experimental_1_1_intercepted_message.html#a126c00394b0ab2c02f511fe39948fe52">length</a>();  <span class="comment">// length on wire</span></div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;};</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1">   43</a></span>&#160;<span class="keyword">enum class</span> <a class="code" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1">InterceptionHookPoints</a> {</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;  <span class="comment">/* The first two in this list are for clients and servers */</span></div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;  <a class="code" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a68f9cc22793a30bf451f5d94c283f371">PRE_SEND_INITIAL_METADATA</a>,</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;  <a class="code" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a78e48d97d3b04c3bc07cc5e015bae473">PRE_SEND_MESSAGE</a>,</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;  <a class="code" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a787bde31497aaaccd0e780928a34ba3c">PRE_SEND_STATUS</a> <span class="comment">/* server only */</span>,</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;  <a class="code" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1aae41c3d206fb78da7ea1baff522fe734">PRE_SEND_CLOSE</a> <span class="comment">/* client only */</span>,</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;  <span class="comment">/* The following three are for hijacked clients only and can only be</span></div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment">     registered by the global interceptor */</span></div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;  <a class="code" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1ae1edf7ebacfc20d107e332ed0df262d2">PRE_RECV_INITIAL_METADATA</a>,</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;  <a class="code" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1aed5412a55f4c64aab2e6492c79c91422">PRE_RECV_MESSAGE</a>,</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;  <a class="code" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1aac79efae31b3773d455797286cd0a3c3">PRE_RECV_STATUS</a>,</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;  <span class="comment">/* The following two are for all clients and servers */</span></div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;  <a class="code" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a294bdaeb2f3c15f0c7529ecdb04daea8">POST_RECV_INITIAL_METADATA</a>,</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;  <a class="code" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1ab65173742bb81f390a2bbe48279a1d22">POST_RECV_MESSAGE</a>,</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;  <a class="code" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a97b298c9f3aa4e0b5b4865eaa93a5909">POST_RECV_STATUS</a> <span class="comment">/* client only */</span>,</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;  <a class="code" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a28873db230a854864aaf46ce3c7d282a">POST_RECV_CLOSE</a> <span class="comment">/* server only */</span>,</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;  <span class="comment">/* This is a special hook point available to both clients and servers when</span></div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment">     TryCancel() is performed.</span></div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment">     - No other hook points will be present along with this.</span></div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment">     - It is illegal for an interceptor to block/delay this operation.</span></div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment">     - ALL interceptors see this hook point irrespective of whether the RPC was</span></div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment">     hijacked or not. */</span></div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;  <a class="code" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1afeaf95b857178c518bb74d59eb39aa23">PRE_SEND_CANCEL</a>,</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;  <a class="code" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a005432205f3c52f3321eab4485d84c36">NUM_INTERCEPTION_HOOKS</a></div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;};</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_interceptor_batch_methods.html">   69</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1experimental_1_1_interceptor_batch_methods.html">InterceptorBatchMethods</a> {</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_interceptor_batch_methods.html#a55f28c464881763e44c003ad945395a5">   71</a></span>&#160;  <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1experimental_1_1_interceptor_batch_methods.html#a55f28c464881763e44c003ad945395a5">~InterceptorBatchMethods</a>(){};</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;  <span class="comment">// Queries to check whether the current batch has an interception hook point</span></div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;  <span class="comment">// of type \a type</span></div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> QueryInterceptionHookPoint(<a class="code" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1">InterceptionHookPoints</a> type) = 0;</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;  <span class="comment">// Calling this will signal that the interceptor is done intercepting the</span></div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;  <span class="comment">// current batch of the RPC.</span></div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;  <span class="comment">// Proceed is a no-op if the batch contains PRE_SEND_CANCEL. Simply returning</span></div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;  <span class="comment">// from the Intercept method does the job of continuing the RPC in this case.</span></div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Proceed() = 0;</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;  <span class="comment">// Calling this indicates that the interceptor has hijacked the RPC (only</span></div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;  <span class="comment">// valid if the batch contains send_initial_metadata on the client side)</span></div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Hijack() = 0;</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;  <span class="comment">// Returns a modifable ByteBuffer holding serialized form of the message to be</span></div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;  <span class="comment">// sent</span></div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;  <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1_byte_buffer.html">ByteBuffer</a>* GetSendMessage() = 0;</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;  <span class="comment">// Returns a modifiable multimap of the initial metadata to be sent</span></div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;  <span class="keyword">virtual</span> std::multimap&lt;grpc::string, grpc::string&gt;*</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;  GetSendInitialMetadata() = 0;</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;  <span class="comment">// Returns the status to be sent</span></div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;  <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1_status.html">Status</a> GetSendStatus() = 0;</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;  <span class="comment">// Modifies the status with \a status</span></div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> ModifySendStatus(<span class="keyword">const</span> <a class="code" href="classgrpc_1_1_status.html">Status</a>&amp; status) = 0;</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;  <span class="comment">// Returns a modifiable multimap of the trailing metadata to be sent</span></div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;  <span class="keyword">virtual</span> std::multimap&lt;grpc::string, grpc::string&gt;*</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;  GetSendTrailingMetadata() = 0;</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;  <span class="comment">// Returns a pointer to the modifiable received message. Note that the message</span></div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;  <span class="comment">// is already deserialized</span></div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span>* GetRecvMessage() = 0;</div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;</div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;  <span class="comment">// Returns a modifiable multimap of the received initial metadata</span></div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;  <span class="keyword">virtual</span> std::multimap&lt;grpc::string_ref, grpc::string_ref&gt;*</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;  GetRecvInitialMetadata() = 0;</div><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;</div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;  <span class="comment">// Returns a modifiable view of the received status</span></div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;  <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1_status.html">Status</a>* GetRecvStatus() = 0;</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;</div><div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;  <span class="comment">// Returns a modifiable multimap of the received trailing metadata</span></div><div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;  <span class="keyword">virtual</span> std::multimap&lt;grpc::string_ref, grpc::string_ref&gt;*</div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;  GetRecvTrailingMetadata() = 0;</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;</div><div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;  <span class="comment">// Gets an intercepted channel. When a call is started on this interceptor,</span></div><div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;  <span class="comment">// only interceptors after the current interceptor are created from the</span></div><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;  <span class="comment">// factory objects registered with the channel.</span></div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;  <span class="keyword">virtual</span> std::unique_ptr&lt;ChannelInterface&gt; GetInterceptedChannel() = 0;</div><div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;};</div><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;</div><div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_interceptor.html">  123</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1experimental_1_1_interceptor.html">Interceptor</a> {</div><div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_interceptor.html#a6bf6f97f95c4e8ec2c9da1bc7134394e">  125</a></span>&#160;  <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1experimental_1_1_interceptor.html#a6bf6f97f95c4e8ec2c9da1bc7134394e">~Interceptor</a>() {}</div><div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;</div><div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Intercept(<a class="code" href="classgrpc_1_1experimental_1_1_interceptor_batch_methods.html">InterceptorBatchMethods</a>* methods) = 0;</div><div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;};</div><div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;</div><div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;}  <span class="comment">// namespace experimental</span></div><div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;}  <span class="comment">// namespace grpc</span></div><div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;</div><div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="preprocessor">#endif  // GRPCPP_IMPL_CODEGEN_INTERCEPTOR_H</span></div><div class="ttc" id="grpcpp_2impl_2codegen_2config_8h_html"><div class="ttname"><a href="grpcpp_2impl_2codegen_2config_8h.html">config.h</a></div></div>
<div class="ttc" id="namespacegrpc_1_1experimental_html_a03d3481b2c4146f53e90966d4a0fd8a1a78e48d97d3b04c3bc07cc5e015bae473"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a78e48d97d3b04c3bc07cc5e015bae473">grpc::experimental::InterceptionHookPoints::PRE_SEND_MESSAGE</a></div></div>
<div class="ttc" id="classgrpc_1_1experimental_1_1_interceptor_batch_methods_html_a55f28c464881763e44c003ad945395a5"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_interceptor_batch_methods.html#a55f28c464881763e44c003ad945395a5">grpc::experimental::InterceptorBatchMethods::~InterceptorBatchMethods</a></div><div class="ttdeci">virtual ~InterceptorBatchMethods()</div><div class="ttdef"><b>Definition:</b> interceptor.h:71</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="ttdef"><b>Definition:</b> interceptor.h:69</div></div>
<div class="ttc" id="namespacegrpc_1_1experimental_html_a03d3481b2c4146f53e90966d4a0fd8a1aac79efae31b3773d455797286cd0a3c3"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1aac79efae31b3773d455797286cd0a3c3">grpc::experimental::InterceptionHookPoints::PRE_RECV_STATUS</a></div></div>
<div class="ttc" id="grpcpp_2impl_2codegen_2metadata__map_8h_html"><div class="ttname"><a href="grpcpp_2impl_2codegen_2metadata__map_8h.html">metadata_map.h</a></div></div>
<div class="ttc" id="classgrpc_1_1experimental_1_1_intercepted_message_html_aa0cb07e93e88b059e578e01533c396cb"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_intercepted_message.html#aa0cb07e93e88b059e578e01533c396cb">grpc::experimental::InterceptedMessage::Extract</a></div><div class="ttdeci">bool Extract(M *msg)</div></div>
<div class="ttc" id="namespacegrpc_1_1experimental_html_a03d3481b2c4146f53e90966d4a0fd8a1a68f9cc22793a30bf451f5d94c283f371"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a68f9cc22793a30bf451f5d94c283f371">grpc::experimental::InterceptionHookPoints::PRE_SEND_INITIAL_METADATA</a></div></div>
<div class="ttc" id="namespacegrpc_1_1experimental_html_a03d3481b2c4146f53e90966d4a0fd8a1ab65173742bb81f390a2bbe48279a1d22"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1ab65173742bb81f390a2bbe48279a1d22">grpc::experimental::InterceptionHookPoints::POST_RECV_MESSAGE</a></div></div>
<div class="ttc" id="grpc__types_8h_html"><div class="ttname"><a href="grpc__types_8h.html">grpc_types.h</a></div></div>
<div class="ttc" id="namespacegrpc_1_1experimental_html_a03d3481b2c4146f53e90966d4a0fd8a1a787bde31497aaaccd0e780928a34ba3c"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a787bde31497aaaccd0e780928a34ba3c">grpc::experimental::InterceptionHookPoints::PRE_SEND_STATUS</a></div></div>
<div class="ttc" id="namespacegrpc_1_1protobuf_1_1util_html_a717f1a5db6c98d3f27340afd6f28bf7e"><div class="ttname"><a href="namespacegrpc_1_1protobuf_1_1util.html#a717f1a5db6c98d3f27340afd6f28bf7e">grpc::protobuf::util::Status</a></div><div class="ttdeci">::google::protobuf::util::Status Status</div><div class="ttdef"><b>Definition:</b> config_protobuf.h:93</div></div>
<div class="ttc" id="classgrpc_1_1experimental_1_1_intercepted_message_html_a526fc46bb5b14ce05e7f717928c46a41"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_intercepted_message.html#a526fc46bb5b14ce05e7f717928c46a41">grpc::experimental::InterceptedMessage::MutableExtract</a></div><div class="ttdeci">M * MutableExtract()</div></div>
<div class="ttc" id="namespacegrpc_1_1experimental_html_a03d3481b2c4146f53e90966d4a0fd8a1a97b298c9f3aa4e0b5b4865eaa93a5909"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a97b298c9f3aa4e0b5b4865eaa93a5909">grpc::experimental::InterceptionHookPoints::POST_RECV_STATUS</a></div></div>
<div class="ttc" id="namespacegrpc_1_1experimental_html_a03d3481b2c4146f53e90966d4a0fd8a1"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1">grpc::experimental::InterceptionHookPoints</a></div><div class="ttdeci">InterceptionHookPoints</div><div class="ttdef"><b>Definition:</b> interceptor.h:43</div></div>
<div class="ttc" id="namespacegrpc_1_1experimental_html_a03d3481b2c4146f53e90966d4a0fd8a1ae1edf7ebacfc20d107e332ed0df262d2"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1ae1edf7ebacfc20d107e332ed0df262d2">grpc::experimental::InterceptionHookPoints::PRE_RECV_INITIAL_METADATA</a></div></div>
<div class="ttc" id="grpcpp_2impl_2codegen_2byte__buffer_8h_html"><div class="ttname"><a href="grpcpp_2impl_2codegen_2byte__buffer_8h.html">byte_buffer.h</a></div></div>
<div class="ttc" id="classgrpc_1_1experimental_1_1_intercepted_message_html"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_intercepted_message.html">grpc::experimental::InterceptedMessage</a></div><div class="ttdef"><b>Definition:</b> interceptor.h:34</div></div>
<div class="ttc" id="namespacegrpc_1_1experimental_html_a03d3481b2c4146f53e90966d4a0fd8a1aae41c3d206fb78da7ea1baff522fe734"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1aae41c3d206fb78da7ea1baff522fe734">grpc::experimental::InterceptionHookPoints::PRE_SEND_CLOSE</a></div></div>
<div class="ttc" id="namespacegrpc_html"><div class="ttname"><a href="namespacegrpc.html">grpc</a></div><div class="ttdoc">An Alarm posts the user provided tag to its associated completion queue upon expiry or cancellation...</div><div class="ttdef"><b>Definition:</b> alarm.h:33</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="ttdef"><b>Definition:</b> interceptor.h:123</div></div>
<div class="ttc" id="namespacegrpc_1_1experimental_html_a03d3481b2c4146f53e90966d4a0fd8a1a005432205f3c52f3321eab4485d84c36"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a005432205f3c52f3321eab4485d84c36">grpc::experimental::InterceptionHookPoints::NUM_INTERCEPTION_HOOKS</a></div></div>
<div class="ttc" id="classgrpc_1_1experimental_1_1_interceptor_html_a6bf6f97f95c4e8ec2c9da1bc7134394e"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_interceptor.html#a6bf6f97f95c4e8ec2c9da1bc7134394e">grpc::experimental::Interceptor::~Interceptor</a></div><div class="ttdeci">virtual ~Interceptor()</div><div class="ttdef"><b>Definition:</b> interceptor.h:125</div></div>
<div class="ttc" id="namespacegrpc_1_1experimental_html_a03d3481b2c4146f53e90966d4a0fd8a1afeaf95b857178c518bb74d59eb39aa23"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1afeaf95b857178c518bb74d59eb39aa23">grpc::experimental::InterceptionHookPoints::PRE_SEND_CANCEL</a></div></div>
<div class="ttc" id="classgrpc_1_1experimental_1_1_intercepted_message_html_a126c00394b0ab2c02f511fe39948fe52"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_intercepted_message.html#a126c00394b0ab2c02f511fe39948fe52">grpc::experimental::InterceptedMessage::length</a></div><div class="ttdeci">uint64_t length()</div></div>
<div class="ttc" id="grpcpp_2impl_2codegen_2core__codegen__interface_8h_html"><div class="ttname"><a href="grpcpp_2impl_2codegen_2core__codegen__interface_8h.html">core_codegen_interface.h</a></div></div>
<div class="ttc" id="classgrpc_1_1_status_html"><div class="ttname"><a href="classgrpc_1_1_status.html">grpc::Status</a></div><div class="ttdoc">Did it work? If it didn&amp;#39;t, why? </div><div class="ttdef"><b>Definition:</b> status.h:31</div></div>
<div class="ttc" id="namespacegrpc_1_1experimental_html_a03d3481b2c4146f53e90966d4a0fd8a1aed5412a55f4c64aab2e6492c79c91422"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1aed5412a55f4c64aab2e6492c79c91422">grpc::experimental::InterceptionHookPoints::PRE_RECV_MESSAGE</a></div></div>
<div class="ttc" id="classgrpc_1_1_byte_buffer_html"><div class="ttname"><a href="classgrpc_1_1_byte_buffer.html">grpc::ByteBuffer</a></div><div class="ttdoc">A sequence of bytes. </div><div class="ttdef"><b>Definition:</b> byte_buffer.h:62</div></div>
<div class="ttc" id="namespacegrpc_1_1experimental_html_a03d3481b2c4146f53e90966d4a0fd8a1a294bdaeb2f3c15f0c7529ecdb04daea8"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a294bdaeb2f3c15f0c7529ecdb04daea8">grpc::experimental::InterceptionHookPoints::POST_RECV_INITIAL_METADATA</a></div></div>
<div class="ttc" id="namespacegrpc_1_1experimental_html_a03d3481b2c4146f53e90966d4a0fd8a1a28873db230a854864aaf46ce3c7d282a"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a28873db230a854864aaf46ce3c7d282a">grpc::experimental::InterceptionHookPoints::POST_RECV_CLOSE</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Dec 5 2018 14:10:18 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>