carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
							<!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: GRPCStreamingProtoCall Class 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.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&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> &#124;
<a href="#pub-static-methods">Class Methods</a>  </div>
  <div class="headertitle">
<div class="title">GRPCStreamingProtoCall Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A client-streaming RPC call with Protobuf.  
 <a href="interface_g_r_p_c_streaming_proto_call.html#details">More...</a></p>

<p><code>#import &lt;<a class="el" href="_proto_r_p_c_8h_source.html">ProtoRPC.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:ab43d01572f6ddd58272873299bd745b3"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_streaming_proto_call.html#ab43d01572f6ddd58272873299bd745b3">NS_UNAVAILABLE</a></td></tr>
<tr class="separator:ab43d01572f6ddd58272873299bd745b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b272ca4953cb12e26354f794c3fb7d7"><td class="memItemLeft" align="right" valign="top">(nullable instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_streaming_proto_call.html#a2b272ca4953cb12e26354f794c3fb7d7">initWithRequestOptions:responseHandler:callOptions:responseClass:</a></td></tr>
<tr class="memdesc:a2b272ca4953cb12e26354f794c3fb7d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Users should not use this initializer directly.  <a href="interface_g_r_p_c_streaming_proto_call.html#a2b272ca4953cb12e26354f794c3fb7d7">More...</a><br /></td></tr>
<tr class="separator:a2b272ca4953cb12e26354f794c3fb7d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fb7aac765032282779cf83d438a938c"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_streaming_proto_call.html#a1fb7aac765032282779cf83d438a938c">start</a></td></tr>
<tr class="memdesc:a1fb7aac765032282779cf83d438a938c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the call.  <a href="interface_g_r_p_c_streaming_proto_call.html#a1fb7aac765032282779cf83d438a938c">More...</a><br /></td></tr>
<tr class="separator:a1fb7aac765032282779cf83d438a938c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a679f3d3373b0929c246f366458c24b99"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_streaming_proto_call.html#a679f3d3373b0929c246f366458c24b99">cancel</a></td></tr>
<tr class="memdesc:a679f3d3373b0929c246f366458c24b99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel the request of this call at best effort.  <a href="interface_g_r_p_c_streaming_proto_call.html#a679f3d3373b0929c246f366458c24b99">More...</a><br /></td></tr>
<tr class="separator:a679f3d3373b0929c246f366458c24b99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f2736aa51c9b9456b8ad15d80502cf0"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_streaming_proto_call.html#a3f2736aa51c9b9456b8ad15d80502cf0">writeMessage:</a></td></tr>
<tr class="memdesc:a3f2736aa51c9b9456b8ad15d80502cf0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a message to the server.  <a href="interface_g_r_p_c_streaming_proto_call.html#a3f2736aa51c9b9456b8ad15d80502cf0">More...</a><br /></td></tr>
<tr class="separator:a3f2736aa51c9b9456b8ad15d80502cf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22953dddd7b7c133d5fd067f197896c4"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_streaming_proto_call.html#a22953dddd7b7c133d5fd067f197896c4">finish</a></td></tr>
<tr class="memdesc:a22953dddd7b7c133d5fd067f197896c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finish the RPC request and half-close the call.  <a href="interface_g_r_p_c_streaming_proto_call.html#a22953dddd7b7c133d5fd067f197896c4">More...</a><br /></td></tr>
<tr class="separator:a22953dddd7b7c133d5fd067f197896c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a520b480b583f74d2c5d1f584f7981d5a"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_streaming_proto_call.html#a520b480b583f74d2c5d1f584f7981d5a">receiveNextMessage</a></td></tr>
<tr class="memdesc:a520b480b583f74d2c5d1f584f7981d5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tell gRPC to receive another message.  <a href="interface_g_r_p_c_streaming_proto_call.html#a520b480b583f74d2c5d1f584f7981d5a">More...</a><br /></td></tr>
<tr class="separator:a520b480b583f74d2c5d1f584f7981d5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8692c9f0d29747cacad0474bb2e5c4a8"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_streaming_proto_call.html#a8692c9f0d29747cacad0474bb2e5c4a8">receiveNextMessages:</a></td></tr>
<tr class="memdesc:a8692c9f0d29747cacad0474bb2e5c4a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tell gRPC to receive another N message.  <a href="interface_g_r_p_c_streaming_proto_call.html#a8692c9f0d29747cacad0474bb2e5c4a8">More...</a><br /></td></tr>
<tr class="separator:a8692c9f0d29747cacad0474bb2e5c4a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Class Methods</h2></td></tr>
<tr class="memitem:ab43d01572f6ddd58272873299bd745b3"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_streaming_proto_call.html#ab43d01572f6ddd58272873299bd745b3">NS_UNAVAILABLE</a></td></tr>
<tr class="separator:ab43d01572f6ddd58272873299bd745b3"><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>A client-streaming RPC call with Protobuf. </p>
</div><h2 class="groupheader">Method Documentation</h2>
<a id="a679f3d3373b0929c246f366458c24b99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a679f3d3373b0929c246f366458c24b99">&#9670;&nbsp;</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>Cancel the request of this call at best effort. </p>
<p>It attempts to notify the server that the RPC should be cancelled, and issue didCloseWithTrailingMetadata:error: callback with error code CANCELED if no other error code has already been issued. </p>

</div>
</div>
<a id="a22953dddd7b7c133d5fd067f197896c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22953dddd7b7c133d5fd067f197896c4">&#9670;&nbsp;</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>Finish the RPC request and half-close the call. </p>
<p>The server may still send messages and/or trailers to the client. </p>

</div>
</div>
<a id="a2b272ca4953cb12e26354f794c3fb7d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b272ca4953cb12e26354f794c3fb7d7">&#9670;&nbsp;</a></span>initWithRequestOptions:responseHandler:callOptions:responseClass:</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (nullable instancetype) initWithRequestOptions: </td>
          <td></td>
          <td class="paramtype">(<a class="el" href="interface_g_r_p_c_request_options.html">GRPCRequestOptions</a> *)&#160;</td>
          <td class="paramname"><em>requestOptions</em></td>
        </tr>
        <tr>
          <td class="paramkey">responseHandler:</td>
          <td></td>
          <td class="paramtype">(id&lt; <a class="el" href="protocol_g_r_p_c_proto_response_handler-p.html">GRPCProtoResponseHandler</a> &gt;)&#160;</td>
          <td class="paramname"><em>handler</em></td>
        </tr>
        <tr>
          <td class="paramkey">callOptions:</td>
          <td></td>
          <td class="paramtype">(nullable <a class="el" href="interface_g_r_p_c_call_options.html">GRPCCallOptions</a> *)&#160;</td>
          <td class="paramname"><em>callOptions</em></td>
        </tr>
        <tr>
          <td class="paramkey">responseClass:</td>
          <td></td>
          <td class="paramtype">(Class)&#160;</td>
          <td class="paramname"><em>NS_DESIGNATED_INITIALIZER</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Users should not use this initializer directly. </p>
<p>Call objects will be created, initialized, and returned to users by methods of the generated service. </p>

</div>
</div>
<a id="ab43d01572f6ddd58272873299bd745b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab43d01572f6ddd58272873299bd745b3">&#9670;&nbsp;</a></span>NS_UNAVAILABLE <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">+ (instancetype) NS_UNAVAILABLE </td>
          <td></td>
          <td class="paramname"></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ab43d01572f6ddd58272873299bd745b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab43d01572f6ddd58272873299bd745b3">&#9670;&nbsp;</a></span>NS_UNAVAILABLE <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (instancetype) NS_UNAVAILABLE </td>
          <td></td>
          <td class="paramname"></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a520b480b583f74d2c5d1f584f7981d5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a520b480b583f74d2c5d1f584f7981d5a">&#9670;&nbsp;</a></span>receiveNextMessage</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) receiveNextMessage </td>
          <td></td>
          <td class="paramname"></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Tell gRPC to receive another message. </p>
<p>This method should only be used when flow control is enabled. If flow control is enabled, gRPC will only receive additional messages after the user indicates so by using either receiveNextMessage: or receiveNextMessages: methods. If flow control is not enabled, messages will be automatically received after the previous one is delivered. </p>

</div>
</div>
<a id="a8692c9f0d29747cacad0474bb2e5c4a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8692c9f0d29747cacad0474bb2e5c4a8">&#9670;&nbsp;</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)&#160;</td>
          <td class="paramname"><em>numberOfMessages</em></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Tell gRPC to receive another N message. </p>
<p>This method should only be used when flow control is enabled. If flow control is enabled, the messages received from the server are buffered in gRPC until the user want to receive the next message. If flow control is not enabled, messages will be automatically received after the previous one is delivered. </p>

</div>
</div>
<a id="a1fb7aac765032282779cf83d438a938c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1fb7aac765032282779cf83d438a938c">&#9670;&nbsp;</a></span>start</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) start </td>
          <td></td>
          <td class="paramname"></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Start the call. </p>
<p>This function must only be called once for each instance. </p>

</div>
</div>
<a id="a3f2736aa51c9b9456b8ad15d80502cf0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f2736aa51c9b9456b8ad15d80502cf0">&#9670;&nbsp;</a></span>writeMessage:</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) writeMessage: </td>
          <td></td>
          <td class="paramtype">(GPBMessage *)&#160;</td>
          <td class="paramname"><em>message</em></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Send a message to the server. </p>
<p>The message should be a Protobuf message which will be serialized internally. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/objective-c/ProtoRPC/<a class="el" href="_proto_r_p_c_8h_source.html">ProtoRPC.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 &#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>