carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383
							<!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 C++: grpc::ProtoBufferWriter 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 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 id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_proto_buffer_writer.html">ProtoBufferWriter</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#friends">Friends</a>  </div>
  <div class="headertitle">
<div class="title">grpc::ProtoBufferWriter Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This is a specialization of the protobuf class ZeroCopyOutputStream.  
 <a href="classgrpc_1_1_proto_buffer_writer.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="impl_2codegen_2proto__buffer__writer_8h_source.html">proto_buffer_writer.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2197d65d98500d488c8edbca3d4e77e2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_proto_buffer_writer.html#a2197d65d98500d488c8edbca3d4e77e2">ProtoBufferWriter</a> (<a class="el" href="classgrpc_1_1_byte_buffer.html">ByteBuffer</a> *byte_buffer, int block_size, int total_size)</td></tr>
<tr class="memdesc:a2197d65d98500d488c8edbca3d4e77e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for this derived class.  <a href="classgrpc_1_1_proto_buffer_writer.html#a2197d65d98500d488c8edbca3d4e77e2">More...</a><br /></td></tr>
<tr class="separator:a2197d65d98500d488c8edbca3d4e77e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af812e0ef5b16adce1c70b764f46b71c1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_proto_buffer_writer.html#af812e0ef5b16adce1c70b764f46b71c1">~ProtoBufferWriter</a> () override</td></tr>
<tr class="separator:af812e0ef5b16adce1c70b764f46b71c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad71ffbb8f1f6e5bfedba73fb8bcde0ff"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_proto_buffer_writer.html#ad71ffbb8f1f6e5bfedba73fb8bcde0ff">Next</a> (void **data, int *size) override</td></tr>
<tr class="memdesc:ad71ffbb8f1f6e5bfedba73fb8bcde0ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Give the proto library the next buffer of bytes and its size.  <a href="classgrpc_1_1_proto_buffer_writer.html#ad71ffbb8f1f6e5bfedba73fb8bcde0ff">More...</a><br /></td></tr>
<tr class="separator:ad71ffbb8f1f6e5bfedba73fb8bcde0ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afebe85844c62f4aa47cc4e6e19af8400"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_proto_buffer_writer.html#afebe85844c62f4aa47cc4e6e19af8400">BackUp</a> (int count) override</td></tr>
<tr class="memdesc:afebe85844c62f4aa47cc4e6e19af8400"><td class="mdescLeft">&#160;</td><td class="mdescRight">Backup by <em>count</em> bytes because Next returned more bytes than needed (only used in the last buffer).  <a href="classgrpc_1_1_proto_buffer_writer.html#afebe85844c62f4aa47cc4e6e19af8400">More...</a><br /></td></tr>
<tr class="separator:afebe85844c62f4aa47cc4e6e19af8400"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af93269371a674dd4feac4ed90a3171f5"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_proto_buffer_writer.html#af93269371a674dd4feac4ed90a3171f5">ByteCount</a> () const override</td></tr>
<tr class="memdesc:af93269371a674dd4feac4ed90a3171f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the total number of bytes written since this object was created.  <a href="classgrpc_1_1_proto_buffer_writer.html#af93269371a674dd4feac4ed90a3171f5">More...</a><br /></td></tr>
<tr class="separator:af93269371a674dd4feac4ed90a3171f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a2735ca72a039d465dd538c6f3fa06e20"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__slice__buffer.html">grpc_slice_buffer</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_proto_buffer_writer.html#a2735ca72a039d465dd538c6f3fa06e20">slice_buffer</a> ()</td></tr>
<tr class="separator:a2735ca72a039d465dd538c6f3fa06e20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a656f1f4835a8f4e2944cb6ce92454c8b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_proto_buffer_writer.html#a656f1f4835a8f4e2944cb6ce92454c8b">set_byte_count</a> (int64_t byte_count)</td></tr>
<tr class="separator:a656f1f4835a8f4e2944cb6ce92454c8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a7bb6d66e5a6bcf0eee76cb156ab598d4"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_proto_buffer_writer.html#a7bb6d66e5a6bcf0eee76cb156ab598d4">internal::ProtoBufferWriterPeer</a></td></tr>
<tr class="separator:a7bb6d66e5a6bcf0eee76cb156ab598d4"><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>This is a specialization of the protobuf class ZeroCopyOutputStream. </p>
<p>The principle is to give the proto layer one buffer of bytes at a time that it can use to serialize the next portion of the message, with the option to "backup" if more buffer is given than required at the last buffer.</p>
<p>Read more about ZeroCopyOutputStream interface here: <a href="https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.io.zero_copy_stream#ZeroCopyOutputStream">https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.io.zero_copy_stream#ZeroCopyOutputStream</a> </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2197d65d98500d488c8edbca3d4e77e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2197d65d98500d488c8edbca3d4e77e2">&#9670;&nbsp;</a></span>ProtoBufferWriter()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">grpc::ProtoBufferWriter::ProtoBufferWriter </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgrpc_1_1_byte_buffer.html">ByteBuffer</a> *&#160;</td>
          <td class="paramname"><em>byte_buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>block_size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>total_size</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">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructor for this derived class. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">byte_buffer</td><td>A pointer to the <a class="el" href="classgrpc_1_1_byte_buffer.html" title="A sequence of bytes.">grpc::ByteBuffer</a> created </td></tr>
    <tr><td class="paramdir"></td><td class="paramname">block_size</td><td>How big are the chunks to allocate at a time </td></tr>
    <tr><td class="paramdir"></td><td class="paramname">total_size</td><td>How many total bytes are required for this proto </td></tr>
  </table>
  </dd>
</dl>
<p>Create an empty raw byte buffer and look at its underlying slice buffer</p>

</div>
</div>
<a id="af812e0ef5b16adce1c70b764f46b71c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af812e0ef5b16adce1c70b764f46b71c1">&#9670;&nbsp;</a></span>~ProtoBufferWriter()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">grpc::ProtoBufferWriter::~ProtoBufferWriter </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afebe85844c62f4aa47cc4e6e19af8400"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afebe85844c62f4aa47cc4e6e19af8400">&#9670;&nbsp;</a></span>BackUp()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void grpc::ProtoBufferWriter::BackUp </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>count</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Backup by <em>count</em> bytes because Next returned more bytes than needed (only used in the last buffer). </p>
<p><em>count</em> must be less than or equal too the last buffer returned from next. </p>
<ol type="1">
<li>Remove the partially-used last slice from the slice buffer</li>
<li>Split it into the needed (if any) and unneeded part</li>
<li>Add the needed part back to the slice buffer</li>
<li>Mark that we still have the remaining part (for later use/unref)</li>
</ol>

</div>
</div>
<a id="af93269371a674dd4feac4ed90a3171f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af93269371a674dd4feac4ed90a3171f5">&#9670;&nbsp;</a></span>ByteCount()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int64_t grpc::ProtoBufferWriter::ByteCount </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the total number of bytes written since this object was created. </p>

</div>
</div>
<a id="ad71ffbb8f1f6e5bfedba73fb8bcde0ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad71ffbb8f1f6e5bfedba73fb8bcde0ff">&#9670;&nbsp;</a></span>Next()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool grpc::ProtoBufferWriter::Next </td>
          <td>(</td>
          <td class="paramtype">void **&#160;</td>
          <td class="paramname"><em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>size</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">inline</span><span class="mlabel">override</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Give the proto library the next buffer of bytes and its size. </p>
<p>It is safe for the caller to write from data[0, size - 1]. </p>
<p>If we have a backup slice, we should use it first</p>

</div>
</div>
<a id="a656f1f4835a8f4e2944cb6ce92454c8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a656f1f4835a8f4e2944cb6ce92454c8b">&#9670;&nbsp;</a></span>set_byte_count()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void grpc::ProtoBufferWriter::set_byte_count </td>
          <td>(</td>
          <td class="paramtype">int64_t&#160;</td>
          <td class="paramname"><em>byte_count</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a2735ca72a039d465dd538c6f3fa06e20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2735ca72a039d465dd538c6f3fa06e20">&#9670;&nbsp;</a></span>slice_buffer()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structgrpc__slice__buffer.html">grpc_slice_buffer</a>* grpc::ProtoBufferWriter::slice_buffer </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a7bb6d66e5a6bcf0eee76cb156ab598d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bb6d66e5a6bcf0eee76cb156ab598d4">&#9670;&nbsp;</a></span>internal::ProtoBufferWriterPeer</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">friend class internal::ProtoBufferWriterPeer</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/grpcpp/impl/codegen/<a class="el" href="impl_2codegen_2proto__buffer__writer_8h_source.html">proto_buffer_writer.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 3 2021 19:17:24 for GRPC 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>