natas_hw
/
grpc
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
grpc/objc/protocol_g_r_p_c_response_h...

278 lines
15 KiB
HTML
Raw Blame History

<!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: &lt;GRPCResponseHandler&gt; 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
&#160;<span id="projectnumber">1.58.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Instance Methods</a> </div>
<div class="headertitle">
<div class="title">&lt;GRPCResponseHandler&gt; Protocol Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>An object can implement this protocol to receive responses from server from a call.
<a href="protocol_g_r_p_c_response_handler-p.html#details">More...</a></p>
<p><code>#import &lt;<a class="el" href="_g_r_p_c_call_8h_source.html">GRPCCall.h</a>&gt;</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:adc82f4ed3ffc8f7c0e91beed9538dbd6"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_g_r_p_c_response_handler-p.html#adc82f4ed3ffc8f7c0e91beed9538dbd6">didReceiveInitialMetadata:</a></td></tr>
<tr class="memdesc:adc82f4ed3ffc8f7c0e91beed9538dbd6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issued when initial metadata is received from the server. <a href="protocol_g_r_p_c_response_handler-p.html#adc82f4ed3ffc8f7c0e91beed9538dbd6">More...</a><br /></td></tr>
<tr class="separator:adc82f4ed3ffc8f7c0e91beed9538dbd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1cc519d6bf578da70a507197c99dc312"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_g_r_p_c_response_handler-p.html#a1cc519d6bf578da70a507197c99dc312">didReceiveRawMessage:</a></td></tr>
<tr class="memdesc:a1cc519d6bf578da70a507197c99dc312"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issued when a message is received from the server. <a href="protocol_g_r_p_c_response_handler-p.html#a1cc519d6bf578da70a507197c99dc312">More...</a><br /></td></tr>
<tr class="separator:a1cc519d6bf578da70a507197c99dc312"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a384dd702a37a2fa7db82b8330cfcddcf"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_g_r_p_c_response_handler-p.html#a384dd702a37a2fa7db82b8330cfcddcf">didReceiveData:</a></td></tr>
<tr class="memdesc:a384dd702a37a2fa7db82b8330cfcddcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issued when gRPC message is received from the server. <a href="protocol_g_r_p_c_response_handler-p.html#a384dd702a37a2fa7db82b8330cfcddcf">More...</a><br /></td></tr>
<tr class="separator:a384dd702a37a2fa7db82b8330cfcddcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af69153885066acb9c4431d93dc320049"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_g_r_p_c_response_handler-p.html#af69153885066acb9c4431d93dc320049">didCloseWithTrailingMetadata:error:</a></td></tr>
<tr class="memdesc:af69153885066acb9c4431d93dc320049"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issued when a call finished. <a href="protocol_g_r_p_c_response_handler-p.html#af69153885066acb9c4431d93dc320049">More...</a><br /></td></tr>
<tr class="separator:af69153885066acb9c4431d93dc320049"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c5aa4f2f8623e00344ca5e6a3180300"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_g_r_p_c_response_handler-p.html#a5c5aa4f2f8623e00344ca5e6a3180300">didWriteData</a></td></tr>
<tr class="memdesc:a5c5aa4f2f8623e00344ca5e6a3180300"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issued when flow control is enabled for the call and a message written with GRPCCall2::writeData is passed to gRPC core with SEND_MESSAGE operation. <a href="protocol_g_r_p_c_response_handler-p.html#a5c5aa4f2f8623e00344ca5e6a3180300">More...</a><br /></td></tr>
<tr class="separator:a5c5aa4f2f8623e00344ca5e6a3180300"><td class="memSeparator" colspan="2">&#160;</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="-"/>&#160;Properties inherited from <a class="el" href="protocol_g_r_p_c_dispatchable-p.html">&lt;GRPCDispatchable&gt;</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&#160;</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">&#160;</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">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An object can implement this protocol to receive responses from server from a call. </p>
</div><h2 class="groupheader">Method Documentation</h2>
<a id="af69153885066acb9c4431d93dc320049"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af69153885066acb9c4431d93dc320049">&#9670;&nbsp;</a></span>didCloseWithTrailingMetadata:error:</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">- (void) didCloseWithTrailingMetadata: </td>
<td></td>
<td class="paramtype">(nullable NSDictionary *)&#160;</td>
<td class="paramname"><em>trailingMetadata</em></td>
</tr>
<tr>
<td class="paramkey">error:</td>
<td></td>
<td class="paramtype">(nullable NSError *)&#160;</td>
<td class="paramname"><em>error</em>&#160;</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">optional</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Issued when a call finished. </p>
<p>If the call finished successfully, <code>error</code> is nil and <code>trailingMetadata</code> consists any trailing metadata received from the server. Otherwise, <code>error</code> is non-nil and contains the corresponding error information, including gRPC error codes and error descriptions. </p>
<p>Reimplemented in <a class="el" href="interface_g_r_p_c_interceptor.html#a3788cf6d26ec1df66e975bd571280090">GRPCInterceptor</a>.</p>
</div>
</div>
<a id="a384dd702a37a2fa7db82b8330cfcddcf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a384dd702a37a2fa7db82b8330cfcddcf">&#9670;&nbsp;</a></span>didReceiveData:</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">- (void) didReceiveData: </td>
<td></td>
<td class="paramtype">(id)&#160;</td>
<td class="paramname"><em>data</em></td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">optional</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Issued when gRPC message is received from the server. </p>
<p>The data is always decompressed with gRPC or HTTP compression algorithm specified in the response header. <code>data</code> could be any type as transport layer and interceptors may modify the type of the data (e.g. a Protobuf interceptor may consume NSData typed data and issue GPBMessage typed data to user). Users should interpret <code>data</code> according to the configuration of their calls. Interceptor authors should not assume the type of <code>data</code> unless an agreement is made on how it should be used in a particular call setting. </p>
<p>Reimplemented in <a class="el" href="interface_g_r_p_c_interceptor.html#ae1a71998631c23254d3667b6de40b487">GRPCInterceptor</a>.</p>
</div>
</div>
<a id="adc82f4ed3ffc8f7c0e91beed9538dbd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc82f4ed3ffc8f7c0e91beed9538dbd6">&#9670;&nbsp;</a></span>didReceiveInitialMetadata:</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">- (void) didReceiveInitialMetadata: </td>
<td></td>
<td class="paramtype">(nullable NSDictionary *)&#160;</td>
<td class="paramname"><em>initialMetadata</em></td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">optional</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Issued when initial metadata is received from the server. </p>
<p>Reimplemented in <a class="el" href="interface_g_r_p_c_interceptor.html#a0a50fe0dc7ce33c82814c4949b8f282a">GRPCInterceptor</a>.</p>
</div>
</div>
<a id="a1cc519d6bf578da70a507197c99dc312"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1cc519d6bf578da70a507197c99dc312">&#9670;&nbsp;</a></span>didReceiveRawMessage:</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">- (void) didReceiveRawMessage: </td>
<td></td>
<td class="paramtype">(nullable NSData *)&#160;</td>
<td class="paramname"><em>message</em></td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">optional</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Issued when a message is received from the server. </p>
<p>The message is the raw data received from the server, with decompression and without proto deserialization.</p>
<p><b> This method is deprecated and does not work with interceptors.</b> To use <a class="el" href="interface_g_r_p_c_call2.html" title="A GRPCCall2 object represents an RPC call.">GRPCCall2</a> interface with interceptor, please implement GRPCResponseHandler::didReceiveData method and leave this method unimplemented. If this method and didReceiveRawMessage are implemented at the same time, implementation of this method will be ignored. </p>
</div>
</div>
<a id="a5c5aa4f2f8623e00344ca5e6a3180300"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c5aa4f2f8623e00344ca5e6a3180300">&#9670;&nbsp;</a></span>didWriteData</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">- (void) didWriteData </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">optional</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Issued when flow control is enabled for the call and a message written with GRPCCall2::writeData is passed to gRPC core with SEND_MESSAGE operation. </p>
<p>Reimplemented in <a class="el" href="interface_g_r_p_c_interceptor.html#a4a9d9fbfe49dbe6305ced6cc516da038">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_call_8h_source.html">GRPCCall.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Sep 6 2023 16:09:47 for GRPC Objective-C by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink