Skip to content

Commit 97d41f8

Browse files
ihsandemirihsandemir
authored
Add the new C++ client release v5.3.1 documentation DEX-433 (#1300)
Added the C++ client release v5.3.1 documentation. The logo is old but i did not change it since it is patch to 5.3.0. we can discuss this. This is PR for the https://hazelcast.github.io/hazelcast-cpp-client/doc-index.html web site.
1 parent 874cde2 commit 97d41f8

File tree

1,023 files changed

+179367
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,023 files changed

+179367
-0
lines changed

‎5.3.1/IMDG_blue_logo_square_RGB-dark_200px.png‎

5.02 KB
Loading

‎5.3.1/annotated.html‎

Lines changed: 341 additions & 0 deletions
Large diffs are not rendered by default.

‎5.3.1/annotated_dup.js‎

Lines changed: 245 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎5.3.1/bc_s.png‎

676 Bytes
Loading

‎5.3.1/bc_sd.png‎

635 Bytes
Loading

‎5.3.1/bdwn.png‎

147 Bytes
Loading

‎5.3.1/classes.html‎

Lines changed: 169 additions & 0 deletions
Large diffs are not rendered by default.

‎5.3.1/closed.png‎

132 Bytes
Loading

‎5.3.1/d0/d03/classhazelcast_1_1client_1_1item__event__base.html‎

Lines changed: 260 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,260 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.5"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Hazelcast C++ Client: hazelcast::client::item_event_base Class Reference</title>
9+
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="../../jquery.js"></script>
11+
<script type="text/javascript" src="../../dynsections.js"></script>
12+
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="../../resize.js"></script>
14+
<script type="text/javascript" src="../../navtreedata.js"></script>
15+
<script type="text/javascript" src="../../navtree.js"></script>
16+
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
17+
<script type="text/javascript" src="../../search/searchdata.js"></script>
18+
<script type="text/javascript" src="../../search/search.js"></script>
19+
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
20+
</head>
21+
<body>
22+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
23+
<div id="titlearea">
24+
<table cellspacing="0" cellpadding="0">
25+
<tbody>
26+
<tr id="projectrow">
27+
<td id="projectlogo"><img alt="Logo" src="../../IMDG_blue_logo_square_RGB-dark_200px.png"/></td>
28+
<td id="projectalign">
29+
<div id="projectname">Hazelcast C++ Client
30+
</div>
31+
<div id="projectbrief">Hazelcast C++ Client Library</div>
32+
</td>
33+
</tr>
34+
</tbody>
35+
</table>
36+
</div>
37+
<!-- end header part -->
38+
<!-- Generated by Doxygen 1.9.5 -->
39+
<script type="text/javascript">
40+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
41+
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
42+
/* @license-end */
43+
</script>
44+
<script type="text/javascript" src="../../menudata.js"></script>
45+
<script type="text/javascript" src="../../menu.js"></script>
46+
<script type="text/javascript">
47+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
48+
$(function() {
49+
initMenu('../../',true,false,'search.php','Search');
50+
$(document).ready(function() { init_search(); });
51+
});
52+
/* @license-end */
53+
</script>
54+
<div id="main-nav"></div>
55+
</div><!-- top -->
56+
<div id="side-nav" class="ui-resizable side-nav-resizable">
57+
<div id="nav-tree">
58+
<div id="nav-tree-contents">
59+
<div id="nav-sync" class="sync"></div>
60+
</div>
61+
</div>
62+
<div id="splitbar" style="-moz-user-select:none;"
63+
class="ui-resizable-handle">
64+
</div>
65+
</div>
66+
<script type="text/javascript">
67+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
68+
$(document).ready(function(){initNavTree('d0/d03/classhazelcast_1_1client_1_1item__event__base.html','../../'); initResizable(); });
69+
/* @license-end */
70+
</script>
71+
<div id="doc-content">
72+
<!-- window showing the filter options -->
73+
<div id="MSearchSelectWindow"
74+
onmouseover="return searchBox.OnSearchSelectShow()"
75+
onmouseout="return searchBox.OnSearchSelectHide()"
76+
onkeydown="return searchBox.OnSearchSelectKey(event)">
77+
</div>
78+
79+
<!-- iframe showing the search results (closed by default) -->
80+
<div id="MSearchResultsWindow">
81+
<div id="MSearchResults">
82+
<div class="SRPage">
83+
<div id="SRIndex">
84+
<div id="SRResults"></div>
85+
<div class="SRStatus" id="Loading">Loading...</div>
86+
<div class="SRStatus" id="Searching">Searching...</div>
87+
<div class="SRStatus" id="NoMatches">No Matches</div>
88+
</div>
89+
</div>
90+
</div>
91+
</div>
92+
93+
<div class="header">
94+
<div class="summary">
95+
<a href="#pub-methods">Public Member Functions</a> &#124;
96+
<a href="../../dc/db7/classhazelcast_1_1client_1_1item__event__base-members.html">List of all members</a> </div>
97+
<div class="headertitle"><div class="title">hazelcast::client::item_event_base Class Reference</div></div>
98+
</div><!--header-->
99+
<div class="contents">
100+
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
101+
<img id="dynsection-0-trigger" src="../../closed.png" alt="+"/> Inheritance diagram for hazelcast::client::item_event_base:</div>
102+
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
103+
</div>
104+
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
105+
<div class="center">
106+
<img src="../../d0/d03/classhazelcast_1_1client_1_1item__event__base.png" usemap="#hazelcast::client::item_5Fevent_5Fbase_map" alt=""/>
107+
<map id="hazelcast::client::item_5Fevent_5Fbase_map" name="hazelcast::client::item_5Fevent_5Fbase_map">
108+
<area href="../../d9/d82/classhazelcast_1_1client_1_1item__event.html" alt="hazelcast::client::item_event" shape="rect" coords="0,56,201,80"/>
109+
</map>
110+
</div></div>
111+
<table class="memberdecls">
112+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
113+
Public Member Functions</h2></td></tr>
114+
<tr class="memitem:a397cc4348824d1cd28880c41306c91c4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d03/classhazelcast_1_1client_1_1item__event__base.html#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>
115+
<tr class="separator:a397cc4348824d1cd28880c41306c91c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
116+
<tr class="memitem: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="../../d0/d03/classhazelcast_1_1client_1_1item__event__base.html#a1ae5e3e0e77830a2a2ebf8a531631f46">get_member</a> () const</td></tr>
117+
<tr class="memdesc:a1ae5e3e0e77830a2a2ebf8a531631f46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the member fired this event. <a href="../../d0/d03/classhazelcast_1_1client_1_1item__event__base.html#a1ae5e3e0e77830a2a2ebf8a531631f46">More...</a><br /></td></tr>
118+
<tr class="separator:a1ae5e3e0e77830a2a2ebf8a531631f46"><td class="memSeparator" colspan="2">&#160;</td></tr>
119+
<tr class="memitem:a1429c8bf469f79125ec74a27ccba7781"><td class="memItemLeft" align="right" valign="top">item_event_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d03/classhazelcast_1_1client_1_1item__event__base.html#a1429c8bf469f79125ec74a27ccba7781">get_event_type</a> () const</td></tr>
120+
<tr class="memdesc:a1429c8bf469f79125ec74a27ccba7781"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the event type. <a href="../../d0/d03/classhazelcast_1_1client_1_1item__event__base.html#a1429c8bf469f79125ec74a27ccba7781">More...</a><br /></td></tr>
121+
<tr class="separator:a1429c8bf469f79125ec74a27ccba7781"><td class="memSeparator" colspan="2">&#160;</td></tr>
122+
<tr class="memitem:a1f0b7c0584173f15d19e23930b9338fe"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d03/classhazelcast_1_1client_1_1item__event__base.html#a1f0b7c0584173f15d19e23930b9338fe">get_name</a> () const</td></tr>
123+
<tr class="memdesc:a1f0b7c0584173f15d19e23930b9338fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the name of the collection for this event. <a href="../../d0/d03/classhazelcast_1_1client_1_1item__event__base.html#a1f0b7c0584173f15d19e23930b9338fe">More...</a><br /></td></tr>
124+
<tr class="separator:a1f0b7c0584173f15d19e23930b9338fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
125+
</table>
126+
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
127+
<div class="textblock">
128+
<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>
129+
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
130+
<a id="a397cc4348824d1cd28880c41306c91c4" name="a397cc4348824d1cd28880c41306c91c4"></a>
131+
<h2 class="memtitle"><span class="permalink"><a href="#a397cc4348824d1cd28880c41306c91c4">&#9670;&#160;</a></span>item_event_base()</h2>
132+
133+
<div class="memitem">
134+
<div class="memproto">
135+
<table class="memname">
136+
<tr>
137+
<td class="memname">hazelcast::client::item_event_base::item_event_base </td>
138+
<td>(</td>
139+
<td class="paramtype">const std::string &amp;&#160;</td>
140+
<td class="paramname"><em>name</em>, </td>
141+
</tr>
142+
<tr>
143+
<td class="paramkey"></td>
144+
<td></td>
145+
<td class="paramtype">const <a class="el" href="../../d8/d16/classhazelcast_1_1client_1_1member.html">member</a> &amp;&#160;</td>
146+
<td class="paramname"><em>member</em>, </td>
147+
</tr>
148+
<tr>
149+
<td class="paramkey"></td>
150+
<td></td>
151+
<td class="paramtype">const item_event_type &amp;&#160;</td>
152+
<td class="paramname"><em>event_type</em>&#160;</td>
153+
</tr>
154+
<tr>
155+
<td></td>
156+
<td>)</td>
157+
<td></td><td></td>
158+
</tr>
159+
</table>
160+
</div><div class="memdoc">
161+
162+
<p class="definition">Definition at line <a class="el" href="../../da/dbe/proxy_8cpp_source.html#l02693">2693</a> of file <a class="el" href="../../da/dbe/proxy_8cpp_source.html">proxy.cpp</a>.</p>
163+
<div class="fragment"><div class="line"><span class="lineno"> 2696</span> : name_(name)</div>
164+
<div class="line"><span class="lineno"> 2697</span> , member_(member)</div>
165+
<div class="line"><span class="lineno"> 2698</span> , event_type_(event_type)</div>
166+
<div class="line"><span class="lineno"> 2699</span>{}</div>
167+
</div><!-- fragment -->
168+
</div>
169+
</div>
170+
<h2 class="groupheader">Member Function Documentation</h2>
171+
<a id="a1429c8bf469f79125ec74a27ccba7781" name="a1429c8bf469f79125ec74a27ccba7781"></a>
172+
<h2 class="memtitle"><span class="permalink"><a href="#a1429c8bf469f79125ec74a27ccba7781">&#9670;&#160;</a></span>get_event_type()</h2>
173+
174+
<div class="memitem">
175+
<div class="memproto">
176+
<table class="memname">
177+
<tr>
178+
<td class="memname">item_event_type hazelcast::client::item_event_base::get_event_type </td>
179+
<td>(</td>
180+
<td class="paramname"></td><td>)</td>
181+
<td> const</td>
182+
</tr>
183+
</table>
184+
</div><div class="memdoc">
185+
186+
<p>Return the event type. </p>
187+
<dl class="section return"><dt>Returns</dt><dd>event type ItemEventType </dd></dl>
188+
189+
<p class="definition">Definition at line <a class="el" href="../../da/dbe/proxy_8cpp_source.html#l02708">2708</a> of file <a class="el" href="../../da/dbe/proxy_8cpp_source.html">proxy.cpp</a>.</p>
190+
<div class="fragment"><div class="line"><span class="lineno"> 2709</span>{</div>
191+
<div class="line"><span class="lineno"> 2710</span> <span class="keywordflow">return</span> event_type_;</div>
192+
<div class="line"><span class="lineno"> 2711</span>}</div>
193+
</div><!-- fragment -->
194+
</div>
195+
</div>
196+
<a id="a1ae5e3e0e77830a2a2ebf8a531631f46" name="a1ae5e3e0e77830a2a2ebf8a531631f46"></a>
197+
<h2 class="memtitle"><span class="permalink"><a href="#a1ae5e3e0e77830a2a2ebf8a531631f46">&#9670;&#160;</a></span>get_member()</h2>
198+
199+
<div class="memitem">
200+
<div class="memproto">
201+
<table class="memname">
202+
<tr>
203+
<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>
204+
<td>(</td>
205+
<td class="paramname"></td><td>)</td>
206+
<td> const</td>
207+
</tr>
208+
</table>
209+
</div><div class="memdoc">
210+
211+
<p>Returns the member fired this event. </p>
212+
<dl class="section return"><dt>Returns</dt><dd>the member fired this event. </dd></dl>
213+
214+
<p class="definition">Definition at line <a class="el" href="../../da/dbe/proxy_8cpp_source.html#l02702">2702</a> of file <a class="el" href="../../da/dbe/proxy_8cpp_source.html">proxy.cpp</a>.</p>
215+
<div class="fragment"><div class="line"><span class="lineno"> 2703</span>{</div>
216+
<div class="line"><span class="lineno"> 2704</span> <span class="keywordflow">return</span> member_;</div>
217+
<div class="line"><span class="lineno"> 2705</span>}</div>
218+
</div><!-- fragment -->
219+
</div>
220+
</div>
221+
<a id="a1f0b7c0584173f15d19e23930b9338fe" name="a1f0b7c0584173f15d19e23930b9338fe"></a>
222+
<h2 class="memtitle"><span class="permalink"><a href="#a1f0b7c0584173f15d19e23930b9338fe">&#9670;&#160;</a></span>get_name()</h2>
223+
224+
<div class="memitem">
225+
<div class="memproto">
226+
<table class="memname">
227+
<tr>
228+
<td class="memname">const std::string &amp; hazelcast::client::item_event_base::get_name </td>
229+
<td>(</td>
230+
<td class="paramname"></td><td>)</td>
231+
<td> const</td>
232+
</tr>
233+
</table>
234+
</div><div class="memdoc">
235+
236+
<p>Returns the name of the collection for this event. </p>
237+
<dl class="section return"><dt>Returns</dt><dd>name of the collection. </dd></dl>
238+
239+
<p class="definition">Definition at line <a class="el" href="../../da/dbe/proxy_8cpp_source.html#l02714">2714</a> of file <a class="el" href="../../da/dbe/proxy_8cpp_source.html">proxy.cpp</a>.</p>
240+
<div class="fragment"><div class="line"><span class="lineno"> 2715</span>{</div>
241+
<div class="line"><span class="lineno"> 2716</span> <span class="keywordflow">return</span> name_;</div>
242+
<div class="line"><span class="lineno"> 2717</span>}</div>
243+
</div><!-- fragment -->
244+
</div>
245+
</div>
246+
<hr/>The documentation for this class was generated from the following files:<ul>
247+
<li>hazelcast/include/hazelcast/client/<a class="el" href="../../d6/d89/item__event_8h_source.html">item_event.h</a></li>
248+
<li>hazelcast/src/hazelcast/client/<a class="el" href="../../da/dbe/proxy_8cpp_source.html">proxy.cpp</a></li>
249+
</ul>
250+
</div><!-- contents -->
251+
</div><!-- doc-content -->
252+
<!-- start footer part -->
253+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
254+
<ul>
255+
<li class="navelem"><b>hazelcast</b></li><li class="navelem"><b>client</b></li><li class="navelem"><a class="el" href="../../d0/d03/classhazelcast_1_1client_1_1item__event__base.html">item_event_base</a></li>
256+
<li class="footer">Generated on Mon Jun 2 2025 12:33:07 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.9.5 </li>
257+
</ul>
258+
</div>
259+
</body>
260+
</html>

‎5.3.1/d0/d03/classhazelcast_1_1client_1_1item__event__base.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
var classhazelcast_1_1client_1_1item__event__base =
2+
[
3+
[ "get_event_type", "d0/d03/classhazelcast_1_1client_1_1item__event__base.html#a1429c8bf469f79125ec74a27ccba7781", null ],
4+
[ "get_member", "d0/d03/classhazelcast_1_1client_1_1item__event__base.html#a1ae5e3e0e77830a2a2ebf8a531631f46", null ],
5+
[ "get_name", "d0/d03/classhazelcast_1_1client_1_1item__event__base.html#a1f0b7c0584173f15d19e23930b9338fe", null ]
6+
];

0 commit comments

Comments
 (0)