Files
rippled/classripple_1_1LockedSociSession.html
2020-08-07 00:47:51 +00:00

421 lines
21 KiB
HTML

<!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>rippled: ripple::LockedSociSession 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">rippled
</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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1LockedSociSession.html">LockedSociSession</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1LockedSociSession-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::LockedSociSession Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for ripple::LockedSociSession:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1LockedSociSession__coll__graph.png" border="0" usemap="#ripple_1_1LockedSociSession_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1LockedSociSession_coll__map" id="ripple_1_1LockedSociSession_coll__map">
<area shape="rect" title=" " alt="" coords="130,199,321,225"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/unique_lock.html" title=" " alt="" coords="5,95,168,136"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html" title="STL class." alt="" coords="7,5,166,32"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="192,95,352,136"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac4db276fa55171b226b84ea36a0352d4"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1LockedSociSession.html#ac4db276fa55171b226b84ea36a0352d4">mutex</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html">std::recursive_mutex</a></td></tr>
<tr class="separator:ac4db276fa55171b226b84ea36a0352d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a5fdf27b562410f31ba6fb96614ec6504"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1LockedSociSession.html#a5fdf27b562410f31ba6fb96614ec6504">LockedSociSession</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; soci::session &gt; it, <a class="el" href="classripple_1_1LockedSociSession.html#ac4db276fa55171b226b84ea36a0352d4">mutex</a> &amp;m)</td></tr>
<tr class="separator:a5fdf27b562410f31ba6fb96614ec6504"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3df71e0b4eadfe4b27e467ea9f26c96c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1LockedSociSession.html#a3df71e0b4eadfe4b27e467ea9f26c96c">LockedSociSession</a> (<a class="el" href="classripple_1_1LockedSociSession.html">LockedSociSession</a> &amp;&amp;rhs) noexcept</td></tr>
<tr class="separator:a3df71e0b4eadfe4b27e467ea9f26c96c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fe34e529facb4e9e15e0a4fa50c2a0e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1LockedSociSession.html#a4fe34e529facb4e9e15e0a4fa50c2a0e">LockedSociSession</a> ()=delete</td></tr>
<tr class="separator:a4fe34e529facb4e9e15e0a4fa50c2a0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5756acaeb781902c5d71c3bd9ca93b59"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1LockedSociSession.html#a5756acaeb781902c5d71c3bd9ca93b59">LockedSociSession</a> (<a class="el" href="classripple_1_1LockedSociSession.html">LockedSociSession</a> const &amp;rhs)=delete</td></tr>
<tr class="separator:a5756acaeb781902c5d71c3bd9ca93b59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5ac3e7685c6bc63527826879c032408"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1LockedSociSession.html">LockedSociSession</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1LockedSociSession.html#ab5ac3e7685c6bc63527826879c032408">operator=</a> (<a class="el" href="classripple_1_1LockedSociSession.html">LockedSociSession</a> const &amp;rhs)=delete</td></tr>
<tr class="separator:ab5ac3e7685c6bc63527826879c032408"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8afa0d4219793e59acb1ebe23e3debfd"><td class="memItemLeft" align="right" valign="top">soci::session *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1LockedSociSession.html#a8afa0d4219793e59acb1ebe23e3debfd">get</a> ()</td></tr>
<tr class="separator:a8afa0d4219793e59acb1ebe23e3debfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21ac2331606f3cb2833dfdd526d7210b"><td class="memItemLeft" align="right" valign="top">soci::session &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1LockedSociSession.html#a21ac2331606f3cb2833dfdd526d7210b">operator*</a> ()</td></tr>
<tr class="separator:a21ac2331606f3cb2833dfdd526d7210b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75fe11942fc748c01d08940b45648d6d"><td class="memItemLeft" align="right" valign="top">soci::session *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1LockedSociSession.html#a75fe11942fc748c01d08940b45648d6d">operator-&gt;</a> ()</td></tr>
<tr class="separator:a75fe11942fc748c01d08940b45648d6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e4a9349582486df237c28181dbc072a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1LockedSociSession.html#a8e4a9349582486df237c28181dbc072a">operator bool</a> () const</td></tr>
<tr class="separator:a8e4a9349582486df237c28181dbc072a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:acdb56719d7109873c9336064d9cbd426"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; soci::session &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1LockedSociSession.html#acdb56719d7109873c9336064d9cbd426">session_</a></td></tr>
<tr class="separator:acdb56719d7109873c9336064d9cbd426"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a117e6d4ce7dce26f1aa8c12e78ec2ed0"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/unique_lock.html">std::unique_lock</a>&lt; <a class="el" href="classripple_1_1LockedSociSession.html#ac4db276fa55171b226b84ea36a0352d4">mutex</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1LockedSociSession.html#a117e6d4ce7dce26f1aa8c12e78ec2ed0">lock_</a></td></tr>
<tr class="separator:a117e6d4ce7dce26f1aa8c12e78ec2ed0"><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 class="definition">Definition at line <a class="el" href="DatabaseCon_8h_source.html#l00037">37</a> of file <a class="el" href="DatabaseCon_8h_source.html">DatabaseCon.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ac4db276fa55171b226b84ea36a0352d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4db276fa55171b226b84ea36a0352d4">&#9670;&nbsp;</a></span>mutex</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1LockedSociSession.html#ac4db276fa55171b226b84ea36a0352d4">ripple::LockedSociSession::mutex</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html">std::recursive_mutex</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="DatabaseCon_8h_source.html#l00040">40</a> of file <a class="el" href="DatabaseCon_8h_source.html">DatabaseCon.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5fdf27b562410f31ba6fb96614ec6504"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fdf27b562410f31ba6fb96614ec6504">&#9670;&nbsp;</a></span>LockedSociSession() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::LockedSociSession::LockedSociSession </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; soci::session &gt;&#160;</td>
<td class="paramname"><em>it</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1LockedSociSession.html#ac4db276fa55171b226b84ea36a0352d4">mutex</a> &amp;&#160;</td>
<td class="paramname"><em>m</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="DatabaseCon_8h_source.html#l00047">47</a> of file <a class="el" href="DatabaseCon_8h_source.html">DatabaseCon.h</a>.</p>
</div>
</div>
<a id="a3df71e0b4eadfe4b27e467ea9f26c96c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3df71e0b4eadfe4b27e467ea9f26c96c">&#9670;&nbsp;</a></span>LockedSociSession() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::LockedSociSession::LockedSociSession </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1LockedSociSession.html">LockedSociSession</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="DatabaseCon_8h_source.html#l00051">51</a> of file <a class="el" href="DatabaseCon_8h_source.html">DatabaseCon.h</a>.</p>
</div>
</div>
<a id="a4fe34e529facb4e9e15e0a4fa50c2a0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fe34e529facb4e9e15e0a4fa50c2a0e">&#9670;&nbsp;</a></span>LockedSociSession() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::LockedSociSession::LockedSociSession </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5756acaeb781902c5d71c3bd9ca93b59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5756acaeb781902c5d71c3bd9ca93b59">&#9670;&nbsp;</a></span>LockedSociSession() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::LockedSociSession::LockedSociSession </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1LockedSociSession.html">LockedSociSession</a> const &amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab5ac3e7685c6bc63527826879c032408"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5ac3e7685c6bc63527826879c032408">&#9670;&nbsp;</a></span>operator=()</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="classripple_1_1LockedSociSession.html">LockedSociSession</a>&amp; ripple::LockedSociSession::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1LockedSociSession.html">LockedSociSession</a> const &amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8afa0d4219793e59acb1ebe23e3debfd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8afa0d4219793e59acb1ebe23e3debfd">&#9670;&nbsp;</a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">soci::session* ripple::LockedSociSession::get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="DatabaseCon_8h_source.html#l00061">61</a> of file <a class="el" href="DatabaseCon_8h_source.html">DatabaseCon.h</a>.</p>
</div>
</div>
<a id="a21ac2331606f3cb2833dfdd526d7210b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21ac2331606f3cb2833dfdd526d7210b">&#9670;&nbsp;</a></span>operator*()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">soci::session&amp; ripple::LockedSociSession::operator* </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="DatabaseCon_8h_source.html#l00066">66</a> of file <a class="el" href="DatabaseCon_8h_source.html">DatabaseCon.h</a>.</p>
</div>
</div>
<a id="a75fe11942fc748c01d08940b45648d6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75fe11942fc748c01d08940b45648d6d">&#9670;&nbsp;</a></span>operator-&gt;()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">soci::session* ripple::LockedSociSession::operator-&gt; </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="DatabaseCon_8h_source.html#l00071">71</a> of file <a class="el" href="DatabaseCon_8h_source.html">DatabaseCon.h</a>.</p>
</div>
</div>
<a id="a8e4a9349582486df237c28181dbc072a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e4a9349582486df237c28181dbc072a">&#9670;&nbsp;</a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::LockedSociSession::operator bool </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">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="DatabaseCon_8h_source.html#l00075">75</a> of file <a class="el" href="DatabaseCon_8h_source.html">DatabaseCon.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="acdb56719d7109873c9336064d9cbd426"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdb56719d7109873c9336064d9cbd426">&#9670;&nbsp;</a></span>session_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt;soci::session&gt; ripple::LockedSociSession::session_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="DatabaseCon_8h_source.html#l00043">43</a> of file <a class="el" href="DatabaseCon_8h_source.html">DatabaseCon.h</a>.</p>
</div>
</div>
<a id="a117e6d4ce7dce26f1aa8c12e78ec2ed0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a117e6d4ce7dce26f1aa8c12e78ec2ed0">&#9670;&nbsp;</a></span>lock_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/unique_lock.html">std::unique_lock</a>&lt;<a class="el" href="classripple_1_1LockedSociSession.html#ac4db276fa55171b226b84ea36a0352d4">mutex</a>&gt; ripple::LockedSociSession::lock_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="DatabaseCon_8h_source.html#l00044">44</a> of file <a class="el" href="DatabaseCon_8h_source.html">DatabaseCon.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated 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>