carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263
							<!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: GRPCRequestOptions 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> &#124;
<a href="#properties">Properties</a>  </div>
  <div class="headertitle">
<div class="title">GRPCRequestOptions Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>HTTP request parameters.  
 <a href="interface_g_r_p_c_request_options.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:a1313dfed07298fd6ddd31b0df78af655"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_request_options.html#a1313dfed07298fd6ddd31b0df78af655">NS_UNAVAILABLE</a></td></tr>
<tr class="separator:a1313dfed07298fd6ddd31b0df78af655"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e7efdc16762d293d59724c521efc00c"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_request_options.html#a0e7efdc16762d293d59724c521efc00c">initWithHost:path:safety:</a></td></tr>
<tr class="memdesc:a0e7efdc16762d293d59724c521efc00c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize with all properties.  <a href="interface_g_r_p_c_request_options.html#a0e7efdc16762d293d59724c521efc00c">More...</a><br /></td></tr>
<tr class="separator:a0e7efdc16762d293d59724c521efc00c"><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:a1313dfed07298fd6ddd31b0df78af655"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_request_options.html#a1313dfed07298fd6ddd31b0df78af655">NS_UNAVAILABLE</a></td></tr>
<tr class="separator:a1313dfed07298fd6ddd31b0df78af655"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a981cdd0594065ef638e7b072124d5812"><td class="memItemLeft" align="right" valign="top">NSString *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_request_options.html#a981cdd0594065ef638e7b072124d5812">host</a></td></tr>
<tr class="memdesc:a981cdd0594065ef638e7b072124d5812"><td class="mdescLeft">&#160;</td><td class="mdescRight">The host serving the RPC service.  <a href="interface_g_r_p_c_request_options.html#a981cdd0594065ef638e7b072124d5812">More...</a><br /></td></tr>
<tr class="separator:a981cdd0594065ef638e7b072124d5812"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80855bd704d0e4f82894f99ce25562ed"><td class="memItemLeft" align="right" valign="top">NSString *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_request_options.html#a80855bd704d0e4f82894f99ce25562ed">path</a></td></tr>
<tr class="memdesc:a80855bd704d0e4f82894f99ce25562ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">The path to the RPC call.  <a href="interface_g_r_p_c_request_options.html#a80855bd704d0e4f82894f99ce25562ed">More...</a><br /></td></tr>
<tr class="separator:a80855bd704d0e4f82894f99ce25562ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a857a1f5e7a6423adf9e3d6f8e2ea3677"><td class="memItemLeft" align="right" valign="top">GRPCCallSafety&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_request_options.html#a857a1f5e7a6423adf9e3d6f8e2ea3677">safety</a></td></tr>
<tr class="memdesc:a857a1f5e7a6423adf9e3d6f8e2ea3677"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specify whether the call is idempotent or cachable.  <a href="interface_g_r_p_c_request_options.html#a857a1f5e7a6423adf9e3d6f8e2ea3677">More...</a><br /></td></tr>
<tr class="separator:a857a1f5e7a6423adf9e3d6f8e2ea3677"><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>HTTP request parameters. </p>
<p>If Protobuf is used, these parameters are automatically generated by Protobuf. If directly using the <a class="el" href="interface_g_r_p_c_call2.html" title="A GRPCCall2 object represents an RPC call.">GRPCCall2</a> class, users should specify these parameters manually. </p>
</div><h2 class="groupheader">Method Documentation</h2>
<a id="a0e7efdc16762d293d59724c521efc00c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e7efdc16762d293d59724c521efc00c">&#9670;&nbsp;</a></span>initWithHost:path:safety:</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (instancetype) initWithHost: </td>
          <td></td>
          <td class="paramtype">(NSString *)&#160;</td>
          <td class="paramname"><em>host</em></td>
        </tr>
        <tr>
          <td class="paramkey">path:</td>
          <td></td>
          <td class="paramtype">(NSString *)&#160;</td>
          <td class="paramname"><em>path</em></td>
        </tr>
        <tr>
          <td class="paramkey">safety:</td>
          <td></td>
          <td class="paramtype">(GRPCCallSafety)&#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>Initialize with all properties. </p>

</div>
</div>
<a id="a1313dfed07298fd6ddd31b0df78af655"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1313dfed07298fd6ddd31b0df78af655">&#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="a1313dfed07298fd6ddd31b0df78af655"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1313dfed07298fd6ddd31b0df78af655">&#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>
<h2 class="groupheader">Property Documentation</h2>
<a id="a981cdd0594065ef638e7b072124d5812"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a981cdd0594065ef638e7b072124d5812">&#9670;&nbsp;</a></span>host</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">- (NSString*) host</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The host serving the RPC service. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">- (NSString*) path</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The path to the RPC call. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">- (GRPCCallSafety) safety</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Specify whether the call is idempotent or cachable. </p>
<p>gRPC may select different HTTP verbs for the call based on this information. The default verb used by gRPC is POST. </p>

</div>
</div>
<hr/>The documentation for this class 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 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>