Add the new C++ client release v5.5.0 documentation HZ-5191

5.5.0/clipboard.js

@@ -0,0 +1,61 @@
+/**
+
+The code below is based on the Doxygen Awesome project, see
+https://github.com/jothepro/doxygen-awesome-css
+
+MIT License
+
+Copyright (c) 2021 - 2022 jothepro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+*/
+
+let clipboard_title = "Copy to clipboard"
+let clipboard_icon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path fill="#888" d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z"/></svg>`
+let clipboard_successIcon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41L9 16.17z"/></svg>`
+let clipboard_successDuration = 1000
+
+$(function() {
+  if(navigator.clipboard) {
+    const fragments = document.getElementsByClassName("fragment")
+    for(const fragment of fragments) {
+      const clipboard_div = document.createElement("div")
+      clipboard_div.classList.add("clipboard")
+      clipboard_div.innerHTML = clipboard_icon
+      clipboard_div.title = clipboard_title
+      $(clipboard_div).click(function() {
+        const content = this.parentNode.cloneNode(true)
+        // filter out line number and folded fragments from file listings
+        content.querySelectorAll(".lineno, .ttc, .foldclosed").forEach((node) => { node.remove() })
+        let text = content.textContent
+        // remove trailing newlines and trailing spaces from empty lines
+        text = text.replace(/^\s*\n/gm,'\n').replace(/\n*$/,'')
+        navigator.clipboard.writeText(text);
+        this.classList.add("success")
+        this.innerHTML = clipboard_successIcon
+        window.setTimeout(() => { // switch back to normal icon after timeout
+            this.classList.remove("success")
+            this.innerHTML = clipboard_icon
+        }, clipboard_successDuration);
+      })
+      fragment.insertBefore(clipboard_div, fragment.firstChild)
+    }
+  }
+})

5.5.0/cookie.js

@@ -0,0 +1,58 @@
+/*!
+ Cookie helper functions
+ Copyright (c) 2023 Dimitri van Heesch
+ Released under MIT license.
+*/
+let Cookie = {
+  cookie_namespace: 'doxygen_',
+
+  readSetting(cookie,defVal) {
+    if (window.chrome) {
+      const val = localStorage.getItem(this.cookie_namespace+cookie) ||
+                  sessionStorage.getItem(this.cookie_namespace+cookie);
+      if (val) return val;
+    } else {
+      let myCookie = this.cookie_namespace+cookie+"=";
+      if (document.cookie) {
+        const index = document.cookie.indexOf(myCookie);
+        if (index != -1) {
+          const valStart = index + myCookie.length;
+          let valEnd = document.cookie.indexOf(";", valStart);
+          if (valEnd == -1) {
+            valEnd = document.cookie.length;
+          }
+          return document.cookie.substring(valStart, valEnd);
+        }
+      }
+    }
+    return defVal;
+  },
+
+  writeSetting(cookie,val,days=10*365) { // default days='forever', 0=session cookie, -1=delete
+    if (window.chrome) {
+      if (days==0) {
+        sessionStorage.setItem(this.cookie_namespace+cookie,val);
+      } else {
+        localStorage.setItem(this.cookie_namespace+cookie,val);
+      }
+    } else {
+      let date = new Date();
+      date.setTime(date.getTime()+(days*24*60*60*1000));
+      const expiration = days!=0 ? "expires="+date.toGMTString()+";" : "";
+      document.cookie = this.cookie_namespace + cookie + "=" +
+                        val + "; SameSite=Lax;" + expiration + "path=/";
+    }
+  },
+
+  eraseSetting(cookie) {
+    if (window.chrome) {
+      if (localStorage.getItem(this.cookie_namespace+cookie)) {
+        localStorage.removeItem(this.cookie_namespace+cookie);
+      } else if (sessionStorage.getItem(this.cookie_namespace+cookie)) {
+        sessionStorage.removeItem(this.cookie_namespace+cookie);
+      }
+    } else {
+      this.writeSetting(cookie,'',-1);
+    }
+  },
+}

5.5.0/d0/d03/classhazelcast_1_1client_1_1item__event__base.html

@@ -0,0 +1,251 @@
+<!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" lang="en-US">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=11"/>
+<meta name="generator" content="Doxygen 1.15.0"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Hazelcast C++ Client: hazelcast::client::item_event_base 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>
+<script type="text/javascript" src="../../clipboard.js"></script>
+<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="../../navtreedata.js"></script>
+<script type="text/javascript" src="../../navtree.js"></script>
+<script type="text/javascript" src="../../cookie.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 id="projectrow">
+  <td id="projectlogo"><img alt="Logo" src="../../IMDG_blue_logo_square_RGB-dark_200px.png"/></td>
+  <td id="projectalign">
+   <div id="projectname">Hazelcast C++ Client
+   </div>
+   <div id="projectbrief">Hazelcast C++ Client Library</div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.15.0 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "../../search/",'.html');
+</script>
+<script type="text/javascript">
+$(function() { codefold.init(); });
+</script>
+<script type="text/javascript" src="../../menudata.js"></script>
+<script type="text/javascript" src="../../menu.js"></script>
+<script type="text/javascript">
+$(function() {
+  initMenu('../../',true,false,'search.php','Search',true);
+  $(function() { init_search(); });
+});
+</script>
+<div id="main-nav"></div>
+</div><!-- top -->
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+  <div id="nav-tree">
+    <div id="nav-tree-contents">
+      <div id="nav-sync" class="sync"></div>
+    </div>
+  </div>
+  <div id="splitbar" style="-moz-user-select:none;" 
+       class="ui-resizable-handle">
+  </div>
+</div>
+<script type="text/javascript">
+$(function(){initNavTree('d0/d03/classhazelcast_1_1client_1_1item__event__base.html','../../','dc/db7/classhazelcast_1_1client_1_1item__event__base-members'); });
+</script>
+<div id="container">
+<div id="doc-content">
+<!-- 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">
+<div id="MSearchResults">
+<div class="SRPage">
+<div id="SRIndex">
+<div id="SRResults"></div>
+<div class="SRStatus" id="Loading">Loading...</div>
+<div class="SRStatus" id="Searching">Searching...</div>
+<div class="SRStatus" id="NoMatches">No Matches</div>
+</div>
+</div>
+</div>
+</div>
+
+<div class="header">
+  <div class="headertitle"><div class="title">hazelcast::client::item_event_base Class Reference</div></div>
+</div><!--header-->
+<div class="contents">
+<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Inheritance diagram for hazelcast::client::item_event_base:</div>
+<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
+</div>
+<div id="dynsection-0-content" class="dyncontent" style="display:none;">
+ <div class="center">
+  <img src="../../d0/d03/classhazelcast_1_1client_1_1item__event__base.png" usemap="#hazelcast_3A_3Aclient_3A_3Aitem_5Fevent_5Fbase_map" alt=""/>
+  <map id="hazelcast_3A_3Aclient_3A_3Aitem_5Fevent_5Fbase_map" name="hazelcast_3A_3Aclient_3A_3Aitem_5Fevent_5Fbase_map">
+<area href="../../d9/d82/classhazelcast_1_1client_1_1item__event.html" alt="hazelcast::client::item_event" shape="rect" coords="0,56,201,80"/>
+  </map>
+</div></div>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
+Public Member Functions</h2></td></tr>
+<tr class="memitem:a397cc4348824d1cd28880c41306c91c4" id="r_a397cc4348824d1cd28880c41306c91c4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a397cc4348824d1cd28880c41306c91c4">item_event_base</a> (const std::string &amp;name, const <a class="el" href="../../d8/d16/classhazelcast_1_1client_1_1member.html">member</a> &amp;<a class="el" href="../../d8/d16/classhazelcast_1_1client_1_1member.html">member</a>, const item_event_type &amp;event_type)</td></tr>
+<tr class="memitem:a1ae5e3e0e77830a2a2ebf8a531631f46" id="r_a1ae5e3e0e77830a2a2ebf8a531631f46"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../d8/d16/classhazelcast_1_1client_1_1member.html">member</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1ae5e3e0e77830a2a2ebf8a531631f46">get_member</a> () const</td></tr>
+<tr class="memdesc:a1ae5e3e0e77830a2a2ebf8a531631f46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the member fired this event.  <br /></td></tr>
+<tr class="memitem:a1429c8bf469f79125ec74a27ccba7781" id="r_a1429c8bf469f79125ec74a27ccba7781"><td class="memItemLeft" align="right" valign="top">item_event_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1429c8bf469f79125ec74a27ccba7781">get_event_type</a> () const</td></tr>
+<tr class="memdesc:a1429c8bf469f79125ec74a27ccba7781"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the event type.  <br /></td></tr>
+<tr class="memitem:a1f0b7c0584173f15d19e23930b9338fe" id="r_a1f0b7c0584173f15d19e23930b9338fe"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1f0b7c0584173f15d19e23930b9338fe">get_name</a> () const</td></tr>
+<tr class="memdesc:a1f0b7c0584173f15d19e23930b9338fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the name of the collection for this event.  <br /></td></tr>
+</table>
+<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
+<div class="textblock">
+<p class="definition">Definition at line <a class="el" href="../../d6/d89/item__event_8h_source.html#l00036">36</a> of file <a class="el" href="../../d6/d89/item__event_8h_source.html">item_event.h</a>.</p>
+</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a id="a397cc4348824d1cd28880c41306c91c4" name="a397cc4348824d1cd28880c41306c91c4"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a397cc4348824d1cd28880c41306c91c4">&#9670;&#160;</a></span>item_event_base()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">hazelcast::client::item_event_base::item_event_base </td>
+          <td>(</td>
+          <td class="paramtype">const std::string &amp;</td>          <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const <a class="el" href="../../d8/d16/classhazelcast_1_1client_1_1member.html">member</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>member</em></span>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const item_event_type &amp;</td>          <td class="paramname"><span class="paramname"><em>event_type</em></span>&#160;)</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="../../da/dbe/proxy_8cpp_source.html#l02698">2698</a> of file <a class="el" href="../../da/dbe/proxy_8cpp_source.html">proxy.cpp</a>.</p>
+<div class="fragment"><div class="line"><span class="lineno"> 2701</span>  : name_(name)</div>
+<div class="line"><span class="lineno"> 2702</span>  , member_(member)</div>
+<div class="line"><span class="lineno"> 2703</span>  , event_type_(event_type)</div>
+<div class="line"><span class="lineno"> 2704</span>{}</div>
+</div><!-- fragment -->
+</div>
+</div>
+<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
+<a id="a1429c8bf469f79125ec74a27ccba7781" name="a1429c8bf469f79125ec74a27ccba7781"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1429c8bf469f79125ec74a27ccba7781">&#9670;&#160;</a></span>get_event_type()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">item_event_type hazelcast::client::item_event_base::get_event_type </td>
+          <td>(</td>
+          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Return the event type. </p>
+<dl class="section return"><dt>Returns</dt><dd>event type ItemEventType </dd></dl>
+
+<p class="definition">Definition at line <a class="el" href="../../da/dbe/proxy_8cpp_source.html#l02713">2713</a> of file <a class="el" href="../../da/dbe/proxy_8cpp_source.html">proxy.cpp</a>.</p>
+<div class="fragment"><div class="line"><span class="lineno"> 2714</span>{</div>
+<div class="line"><span class="lineno"> 2715</span>    <span class="keywordflow">return</span> event_type_;</div>
+<div class="line"><span class="lineno"> 2716</span>}</div>
+</div><!-- fragment -->
+</div>
+</div>
+<a id="a1ae5e3e0e77830a2a2ebf8a531631f46" name="a1ae5e3e0e77830a2a2ebf8a531631f46"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1ae5e3e0e77830a2a2ebf8a531631f46">&#9670;&#160;</a></span>get_member()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const <a class="el" href="../../d8/d16/classhazelcast_1_1client_1_1member.html">member</a> &amp; hazelcast::client::item_event_base::get_member </td>
+          <td>(</td>
+          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Returns the member fired this event. </p>
+<dl class="section return"><dt>Returns</dt><dd>the member fired this event. </dd></dl>
+
+<p class="definition">Definition at line <a class="el" href="../../da/dbe/proxy_8cpp_source.html#l02707">2707</a> of file <a class="el" href="../../da/dbe/proxy_8cpp_source.html">proxy.cpp</a>.</p>
+<div class="fragment"><div class="line"><span class="lineno"> 2708</span>{</div>
+<div class="line"><span class="lineno"> 2709</span>    <span class="keywordflow">return</span> member_;</div>
+<div class="line"><span class="lineno"> 2710</span>}</div>
+</div><!-- fragment -->
+</div>
+</div>
+<a id="a1f0b7c0584173f15d19e23930b9338fe" name="a1f0b7c0584173f15d19e23930b9338fe"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1f0b7c0584173f15d19e23930b9338fe">&#9670;&#160;</a></span>get_name()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const std::string &amp; hazelcast::client::item_event_base::get_name </td>
+          <td>(</td>
+          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Returns the name of the collection for this event. </p>
+<dl class="section return"><dt>Returns</dt><dd>name of the collection. </dd></dl>
+
+<p class="definition">Definition at line <a class="el" href="../../da/dbe/proxy_8cpp_source.html#l02719">2719</a> of file <a class="el" href="../../da/dbe/proxy_8cpp_source.html">proxy.cpp</a>.</p>
+<div class="fragment"><div class="line"><span class="lineno"> 2720</span>{</div>
+<div class="line"><span class="lineno"> 2721</span>    <span class="keywordflow">return</span> name_;</div>
+<div class="line"><span class="lineno"> 2722</span>}</div>
+</div><!-- fragment -->
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following files:<ul>
+<li>hazelcast/include/hazelcast/client/<a class="el" href="../../d6/d89/item__event_8h_source.html">item_event.h</a></li>
+<li>hazelcast/src/hazelcast/client/<a class="el" href="../../da/dbe/proxy_8cpp_source.html">proxy.cpp</a></li>
+</ul>
+</div><!-- contents -->
+</div><!-- doc-content -->
+<div id="page-nav" class="page-nav-panel">
+<div id="page-nav-resize-handle"></div>
+<div id="page-nav-tree">
+<div id="page-nav-contents">
+</div><!-- page-nav-contents -->
+</div><!-- page-nav-tree -->
+</div><!-- page-nav -->
+</div><!-- container -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="navelem"><b>hazelcast</b></li><li class="navelem"><b>client</b></li><li class="navelem"><a href="../../d0/d03/classhazelcast_1_1client_1_1item__event__base.html">item_event_base</a></li>
+    <li class="footer">Generated on <span class="timestamp"></span> for Hazelcast C++ Client by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
+  </ul>
+</div>
+</body>
+</html>

5.5.0/d0/d03/classhazelcast_1_1client_1_1item__event__base.js

@@ -0,0 +1,6 @@
+var classhazelcast_1_1client_1_1item__event__base =
+[
+    [ "get_event_type", "d0/d03/classhazelcast_1_1client_1_1item__event__base.html#a1429c8bf469f79125ec74a27ccba7781", null ],
+    [ "get_member", "d0/d03/classhazelcast_1_1client_1_1item__event__base.html#a1ae5e3e0e77830a2a2ebf8a531631f46", null ],
+    [ "get_name", "d0/d03/classhazelcast_1_1client_1_1item__event__base.html#a1f0b7c0584173f15d19e23930b9338fe", null ]
+];