| <!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> Apache Ignite C++: ignite::binary::BinaryMapWriter< K, V > Class Template 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="projectlogo"><img alt="Logo" src="ignite_logo.png"/></td> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname"> Apache Ignite C++ |
| </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&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&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="namespaceignite.html">ignite</a></li><li class="navelem"><a class="el" href="namespaceignite_1_1binary.html">binary</a></li><li class="navelem"><a class="el" href="classignite_1_1binary_1_1BinaryMapWriter.html">BinaryMapWriter</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classignite_1_1binary_1_1BinaryMapWriter-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">ignite::binary::BinaryMapWriter< K, V > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Binary map writer. |
| <a href="classignite_1_1binary_1_1BinaryMapWriter.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="binary__containers_8h_source.html">binary_containers.h</a>></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:a4a68422e559efcda98e8c492b57d8aa3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryMapWriter.html#a4a68422e559efcda98e8c492b57d8aa3">BinaryMapWriter</a> (impl::binary::BinaryWriterImpl *impl, int32_t id)</td></tr> |
| <tr class="memdesc:a4a68422e559efcda98e8c492b57d8aa3"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classignite_1_1binary_1_1BinaryMapWriter.html#a4a68422e559efcda98e8c492b57d8aa3">More...</a><br /></td></tr> |
| <tr class="separator:a4a68422e559efcda98e8c492b57d8aa3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a31cf449090d8d3417ad5a36616868ebd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryMapWriter.html#a31cf449090d8d3417ad5a36616868ebd">Write</a> (const K &key, const V &val)</td></tr> |
| <tr class="memdesc:a31cf449090d8d3417ad5a36616868ebd"><td class="mdescLeft"> </td><td class="mdescRight">Write a map entry. <a href="classignite_1_1binary_1_1BinaryMapWriter.html#a31cf449090d8d3417ad5a36616868ebd">More...</a><br /></td></tr> |
| <tr class="separator:a31cf449090d8d3417ad5a36616868ebd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a887db8056137c600bfe09b89f372607c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryMapWriter.html#a887db8056137c600bfe09b89f372607c">Close</a> ()</td></tr> |
| <tr class="memdesc:a887db8056137c600bfe09b89f372607c"><td class="mdescLeft"> </td><td class="mdescRight">Close the writer. <a href="classignite_1_1binary_1_1BinaryMapWriter.html#a887db8056137c600bfe09b89f372607c">More...</a><br /></td></tr> |
| <tr class="separator:a887db8056137c600bfe09b89f372607c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<typename K, typename V><br /> |
| class ignite::binary::BinaryMapWriter< K, V ></h3> |
| |
| <p>Binary map writer. </p> |
| <p>Can be used to write map element by element.</p> |
| <p>Use <a class="el" href="classignite_1_1binary_1_1BinaryMapWriter.html#a31cf449090d8d3417ad5a36616868ebd" title="Write a map entry.">Write()</a> method to write map value by value, then finilize the writing by calling <a class="el" href="classignite_1_1binary_1_1BinaryMapWriter.html#a887db8056137c600bfe09b89f372607c" title="Close the writer.">Close()</a> method. Once the <a class="el" href="classignite_1_1binary_1_1BinaryMapWriter.html#a887db8056137c600bfe09b89f372607c" title="Close the writer.">Close()</a> method have been called, instance is not usable and will throw an <a class="el" href="classignite_1_1IgniteError.html" title="Ignite error information.">IgniteError</a> on any subsequent attempt to use it. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a4a68422e559efcda98e8c492b57d8aa3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4a68422e559efcda98e8c492b57d8aa3">◆ </a></span>BinaryMapWriter()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K , typename V > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classignite_1_1binary_1_1BinaryMapWriter.html">ignite::binary::BinaryMapWriter</a>< K, V >::<a class="el" href="classignite_1_1binary_1_1BinaryMapWriter.html">BinaryMapWriter</a> </td> |
| <td>(</td> |
| <td class="paramtype">impl::binary::BinaryWriterImpl * </td> |
| <td class="paramname"><em>impl</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>id</em> </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. </p> |
| <p>Internal call. Should not be used by user.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">impl</td><td>Writer implementation. </td></tr> |
| <tr><td class="paramname">id</td><td>Identifier. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a887db8056137c600bfe09b89f372607c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a887db8056137c600bfe09b89f372607c">◆ </a></span>Close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K , typename V > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classignite_1_1binary_1_1BinaryMapWriter.html">ignite::binary::BinaryMapWriter</a>< K, V >::Close </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> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Close the writer. </p> |
| <p>This method should be called to finilize writing of the map.</p> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="classignite_1_1IgniteError.html" title="Ignite error information.">IgniteError</a></td><td>if the writer instance is closed already. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a31cf449090d8d3417ad5a36616868ebd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a31cf449090d8d3417ad5a36616868ebd">◆ </a></span>Write()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K , typename V > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classignite_1_1binary_1_1BinaryMapWriter.html">ignite::binary::BinaryMapWriter</a>< K, V >::Write </td> |
| <td>(</td> |
| <td class="paramtype">const K & </td> |
| <td class="paramname"><em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const V & </td> |
| <td class="paramname"><em>val</em> </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>Write a map entry. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">key</td><td>Key element of the map entry. </td></tr> |
| <tr><td class="paramname">val</td><td>Value element of the map entry.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="classignite_1_1IgniteError.html" title="Ignite error information.">IgniteError</a></td><td>if the writer instance is closed already. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="binary__containers_8h_source.html">binary_containers.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Mon Jan 10 2022 11:02:04 for Apache Ignite C++ by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |