carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234
							<!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: GRPCUnaryProtoCall 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">GRPCUnaryProtoCall Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A unary-request RPC call with Protobuf.  
 <a href="interface_g_r_p_c_unary_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:a981b223b0f5579f4e3c54929b296eee5"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_unary_proto_call.html#a981b223b0f5579f4e3c54929b296eee5">NS_UNAVAILABLE</a></td></tr>
<tr class="separator:a981b223b0f5579f4e3c54929b296eee5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ee04b6b0a72f62d8233c953cb1ca979"><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_unary_proto_call.html#a0ee04b6b0a72f62d8233c953cb1ca979">initWithRequestOptions:message:responseHandler:callOptions:responseClass:</a></td></tr>
<tr class="memdesc:a0ee04b6b0a72f62d8233c953cb1ca979"><td class="mdescLeft">&#160;</td><td class="mdescRight">Users should not use this initializer directly.  <a href="interface_g_r_p_c_unary_proto_call.html#a0ee04b6b0a72f62d8233c953cb1ca979">More...</a><br /></td></tr>
<tr class="separator:a0ee04b6b0a72f62d8233c953cb1ca979"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af02926a947dc6b4abb4e41801411c8f9"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_unary_proto_call.html#af02926a947dc6b4abb4e41801411c8f9">start</a></td></tr>
<tr class="memdesc:af02926a947dc6b4abb4e41801411c8f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the call.  <a href="interface_g_r_p_c_unary_proto_call.html#af02926a947dc6b4abb4e41801411c8f9">More...</a><br /></td></tr>
<tr class="separator:af02926a947dc6b4abb4e41801411c8f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7880b8488ea7b9315ec920c18ad615fd"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_unary_proto_call.html#a7880b8488ea7b9315ec920c18ad615fd">cancel</a></td></tr>
<tr class="memdesc:a7880b8488ea7b9315ec920c18ad615fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel the request of this call at best effort.  <a href="interface_g_r_p_c_unary_proto_call.html#a7880b8488ea7b9315ec920c18ad615fd">More...</a><br /></td></tr>
<tr class="separator:a7880b8488ea7b9315ec920c18ad615fd"><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:a981b223b0f5579f4e3c54929b296eee5"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_unary_proto_call.html#a981b223b0f5579f4e3c54929b296eee5">NS_UNAVAILABLE</a></td></tr>
<tr class="separator:a981b223b0f5579f4e3c54929b296eee5"><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 unary-request RPC call with Protobuf. </p>
</div><h2 class="groupheader">Method Documentation</h2>
<a id="a7880b8488ea7b9315ec920c18ad615fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7880b8488ea7b9315ec920c18ad615fd">&#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="a0ee04b6b0a72f62d8233c953cb1ca979"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ee04b6b0a72f62d8233c953cb1ca979">&#9670;&nbsp;</a></span>initWithRequestOptions:message: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">message:</td>
          <td></td>
          <td class="paramtype">(GPBMessage *)&#160;</td>
          <td class="paramname"><em>message</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="a981b223b0f5579f4e3c54929b296eee5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a981b223b0f5579f4e3c54929b296eee5">&#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="a981b223b0f5579f4e3c54929b296eee5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a981b223b0f5579f4e3c54929b296eee5">&#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="af02926a947dc6b4abb4e41801411c8f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af02926a947dc6b4abb4e41801411c8f9">&#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>
<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>