carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.6"/>
<title>GRPC Core: gRPC command line tool</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/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
   <div id="projectname">GRPC Core
   &#160;<span id="projectnumber">4.0.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></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="headertitle">
<div class="title">gRPC command line tool </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h2>Overview</h2>
<p>This document describes the command line tool that comes with gRPC repository. It is desirable to have command line tools written in other languages roughly follow the same syntax and flags.</p>
<p>At this point, the tool needs to be built from source, and it should be moved out to grpc-tools repository as a stand alone application once it is mature enough.</p>
<h2>Core functionality</h2>
<p>The command line tool can do the following things:</p>
<ul>
<li>Send unary rpc.</li>
<li>Attach metadata and display received metadata.</li>
<li>Handle common authentication to server.</li>
<li>Infer request/response types from server reflection result.</li>
<li>Find the request/response types from a given proto file.</li>
<li>Read proto request in text form.</li>
<li>Read request in wire form (for protobuf messages, this means serialized binary form).</li>
<li>Display proto response in text form.</li>
<li>Write response in wire form to a file.</li>
</ul>
<p>The command line tool should support the following things:</p>
<ul>
<li>List server services and methods through server reflection.</li>
<li>Fine-grained auth control (such as, use this oauth token to talk to the server).</li>
<li>Send streaming rpc.</li>
</ul>
<h2>Code location</h2>
<p>To use the tool, you need to get the grpc repository and make sure your system has the prerequisites for building grpc from source, given in the https://github.com/grpc/grpc/blob/master/INSTALL.md "installation
instructions".</p>
<p>In order to build the grpc command line tool from a fresh clone of the grpc repository, you need to run the following command to update submodules:</p>
<p>``` git submodule update &ndash;init ```</p>
<p>You also need to have the gflags library installed on your system. On Linux systems, gflags can be installed with the following command:</p>
<p>``` sudo apt-get install libgflags-dev ```</p>
<p>Once the prerequisites are satisfied, you can build the command line tool with the command:</p>
<p>``` $ make grpc_cli ```</p>
<p>The main file can be found at <a href="https://github.com/grpc/grpc/blob/master/test/cpp/util/grpc_cli.cc">https://github.com/grpc/grpc/blob/master/test/cpp/util/grpc_cli.cc</a></p>
<h2>Usage</h2>
<h3>Basic usage</h3>
<p>Send a rpc to a helloworld server at <code>localhost:50051</code>:</p>
<p>``` $ bins/opt/grpc_cli call localhost:50051 SayHello "name: 'world'" \ &ndash;enable_ssl=false ```</p>
<p>On success, the tool will print out</p>
<p>``` Rpc succeeded with OK status Response: message: "Hello world" ```</p>
<p>The <code>localhost:50051</code> part indicates the server you are connecting to. <code>SayHello</code> is (part of) the gRPC method string. Then `"name: 'world'"<code>is the text format of the request proto message. We are not using ssl here by</code>&ndash;enable_ssl=false<code>. For information on more flags, look at the comments of</code>grpc_cli.cc`.</p>
<h3>Use local proto files</h3>
<p>If the server does not have the server reflection service, you will need to provide local proto files containing the service definition. The tool will try to find request/response types from them.</p>
<p>``` $ bins/opt/grpc_cli call localhost:50051 SayHello "name: 'world'" \ &ndash;protofiles=examples/protos/helloworld.proto &ndash;enable_ssl=false ```</p>
<p>If the proto files is not under current directory, you can use <code>--proto_path</code> to specify a new search root.</p>
<h3>Send non-proto rpc</h3>
<p>For using gRPC with protocols other than probobuf, you will need the exact method name string and a file containing the raw bytes to be sent on the wire</p>
<p>``` $ bins/opt/grpc_cli call localhost:50051 /helloworld.Greeter/SayHello &ndash;input_binary_file=input.bin \ &ndash;output_binary_file=output.bin ``<code> On success, you will need to read or decode the response from the</code>output.bin` file. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jun 21 2017 14:13:07 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>