123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.17"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>GRPC Objective-C: <GRPCInterceptorInterface> Protocol Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">GRPC Objective-C
-  <span id="projectnumber">1.36.1</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.17 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */</script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Instance Methods</a> </div>
- <div class="headertitle">
- <div class="title"><GRPCInterceptorInterface> Protocol Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>The <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html" title="The GRPCInterceptorInterface defines the request events that can occur to an interceptor.">GRPCInterceptorInterface</a> defines the request events that can occur to an interceptor.
- <a href="protocol_g_r_p_c_interceptor_interface-p.html#details">More...</a></p>
- <p><code>#import <<a class="el" href="_g_r_p_c_interceptor_8h_source.html">GRPCInterceptor.h</a>></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Instance Methods</h2></td></tr>
- <tr class="memitem:aa7b0ae45db128e5862e2e23f7431185c"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html#aa7b0ae45db128e5862e2e23f7431185c">startWithRequestOptions:callOptions:</a></td></tr>
- <tr class="memdesc:aa7b0ae45db128e5862e2e23f7431185c"><td class="mdescLeft"> </td><td class="mdescRight">To start the call. <a href="protocol_g_r_p_c_interceptor_interface-p.html#aa7b0ae45db128e5862e2e23f7431185c">More...</a><br /></td></tr>
- <tr class="separator:aa7b0ae45db128e5862e2e23f7431185c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afce563b3047786b6525bfe22020fc287"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html#afce563b3047786b6525bfe22020fc287">writeData:</a></td></tr>
- <tr class="memdesc:afce563b3047786b6525bfe22020fc287"><td class="mdescLeft"> </td><td class="mdescRight">To write data to the call. <a href="protocol_g_r_p_c_interceptor_interface-p.html#afce563b3047786b6525bfe22020fc287">More...</a><br /></td></tr>
- <tr class="separator:afce563b3047786b6525bfe22020fc287"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af01872822c9e4adb7c08a51833cde1b7"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html#af01872822c9e4adb7c08a51833cde1b7">finish</a></td></tr>
- <tr class="memdesc:af01872822c9e4adb7c08a51833cde1b7"><td class="mdescLeft"> </td><td class="mdescRight">To finish the stream of requests. <a href="protocol_g_r_p_c_interceptor_interface-p.html#af01872822c9e4adb7c08a51833cde1b7">More...</a><br /></td></tr>
- <tr class="separator:af01872822c9e4adb7c08a51833cde1b7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a89a419fec845010f6f90a3e20aa0debe"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html#a89a419fec845010f6f90a3e20aa0debe">cancel</a></td></tr>
- <tr class="memdesc:a89a419fec845010f6f90a3e20aa0debe"><td class="mdescLeft"> </td><td class="mdescRight">To cancel the call. <a href="protocol_g_r_p_c_interceptor_interface-p.html#a89a419fec845010f6f90a3e20aa0debe">More...</a><br /></td></tr>
- <tr class="separator:a89a419fec845010f6f90a3e20aa0debe"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:add7e9df3d4d740fb065ef372ad56046a"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html#add7e9df3d4d740fb065ef372ad56046a">receiveNextMessages:</a></td></tr>
- <tr class="memdesc:add7e9df3d4d740fb065ef372ad56046a"><td class="mdescLeft"> </td><td class="mdescRight">To indicate the call that the previous interceptor is ready to receive more messages. <a href="protocol_g_r_p_c_interceptor_interface-p.html#add7e9df3d4d740fb065ef372ad56046a">More...</a><br /></td></tr>
- <tr class="separator:add7e9df3d4d740fb065ef372ad56046a"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
- Additional Inherited Members</h2></td></tr>
- <tr class="inherit_header properties_protocol_g_r_p_c_dispatchable-p"><td colspan="2" onclick="javascript:toggleInherit('properties_protocol_g_r_p_c_dispatchable-p')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="protocol_g_r_p_c_dispatchable-p.html"><GRPCDispatchable></a></td></tr>
- <tr class="memitem:ab896f3635c26fb9185a79c0aa26e89c0 inherit properties_protocol_g_r_p_c_dispatchable-p"><td class="memItemLeft" align="right" valign="top">dispatch_queue_t </td><td class="memItemRight" valign="bottom"><a class="el" href="protocol_g_r_p_c_dispatchable-p.html#ab896f3635c26fb9185a79c0aa26e89c0">dispatchQueue</a></td></tr>
- <tr class="memdesc:ab896f3635c26fb9185a79c0aa26e89c0 inherit properties_protocol_g_r_p_c_dispatchable-p"><td class="mdescLeft"> </td><td class="mdescRight">The dispatch queue where the object's methods should be run on. <a href="protocol_g_r_p_c_dispatchable-p.html#ab896f3635c26fb9185a79c0aa26e89c0">More...</a><br /></td></tr>
- <tr class="separator:ab896f3635c26fb9185a79c0aa26e89c0 inherit properties_protocol_g_r_p_c_dispatchable-p"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>The <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html" title="The GRPCInterceptorInterface defines the request events that can occur to an interceptor.">GRPCInterceptorInterface</a> defines the request events that can occur to an interceptor. </p>
- </div><h2 class="groupheader">Method Documentation</h2>
- <a id="a89a419fec845010f6f90a3e20aa0debe"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a89a419fec845010f6f90a3e20aa0debe">◆ </a></span>cancel</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">- (void) cancel </td>
- <td></td>
- <td class="paramname"></td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>To cancel the call. </p>
- <p>Reimplemented in <a class="el" href="interface_g_r_p_c_interceptor.html#aaab821f901be3d354d9fce8f98a12979">GRPCInterceptor</a>.</p>
- </div>
- </div>
- <a id="af01872822c9e4adb7c08a51833cde1b7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af01872822c9e4adb7c08a51833cde1b7">◆ </a></span>finish</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">- (void) finish </td>
- <td></td>
- <td class="paramname"></td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>To finish the stream of requests. </p>
- <p>Reimplemented in <a class="el" href="interface_g_r_p_c_interceptor.html#a53a77a72ebaf711d17e59cb243169032">GRPCInterceptor</a>.</p>
- </div>
- </div>
- <a id="add7e9df3d4d740fb065ef372ad56046a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#add7e9df3d4d740fb065ef372ad56046a">◆ </a></span>receiveNextMessages:</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">- (void) receiveNextMessages: </td>
- <td></td>
- <td class="paramtype">(NSUInteger) </td>
- <td class="paramname"><em>numberOfMessages</em></td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>To indicate the call that the previous interceptor is ready to receive more messages. </p>
- <p>Reimplemented in <a class="el" href="interface_g_r_p_c_interceptor.html#a1e93189dcb502c1f85856f712a384877">GRPCInterceptor</a>.</p>
- </div>
- </div>
- <a id="aa7b0ae45db128e5862e2e23f7431185c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa7b0ae45db128e5862e2e23f7431185c">◆ </a></span>startWithRequestOptions:callOptions:</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">- (void) startWithRequestOptions: </td>
- <td></td>
- <td class="paramtype">(<a class="el" href="interface_g_r_p_c_request_options.html">GRPCRequestOptions</a> *) </td>
- <td class="paramname"><em>requestOptions</em></td>
- </tr>
- <tr>
- <td class="paramkey">callOptions:</td>
- <td></td>
- <td class="paramtype">(<a class="el" href="interface_g_r_p_c_call_options.html">GRPCCallOptions</a> *) </td>
- <td class="paramname"><em>callOptions</em> </td>
- </tr>
- <tr>
- <td></td>
- <td></td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>To start the call. </p>
- <p>This method will only be called once for each instance. </p>
- <p>Reimplemented in <a class="el" href="interface_g_r_p_c_interceptor.html#acede282262511aab39a7dc3b57526aac">GRPCInterceptor</a>.</p>
- </div>
- </div>
- <a id="afce563b3047786b6525bfe22020fc287"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afce563b3047786b6525bfe22020fc287">◆ </a></span>writeData:</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">- (void) writeData: </td>
- <td></td>
- <td class="paramtype">(id) </td>
- <td class="paramname"><em>data</em></td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>To write data to the call. </p>
- <p>Reimplemented in <a class="el" href="interface_g_r_p_c_interceptor.html#a6ee64864731acebc4fa4b3ca47a43f36">GRPCInterceptor</a>.</p>
- </div>
- </div>
- <hr/>The documentation for this protocol was generated from the following file:<ul>
- <li>src/objective-c/GRPCClient/<a class="el" href="_g_r_p_c_interceptor_8h_source.html">GRPCInterceptor.h</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Wed Mar 3 2021 19:20:10 for GRPC Objective-C by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.17
- </small></address>
- </body>
- </html>
|