| <!-- HTML header for doxygen 1.9.8--> |
| <!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.9.8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>ResilientDB SDK: NamespacedDriver 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="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.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" /> |
| <link href="doxygen_html_style.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="logo.png"/></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </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"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function(){initNavTree('classresdb__driver_1_1driver_1_1NamespacedDriver.html',''); initResizable(); }); |
| /* @license-end */ |
| </script> |
| <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="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="classresdb__driver_1_1driver_1_1NamespacedDriver-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">NamespacedDriver Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Base class for creating endpoints (namespaced objects) that can be added under the :class:<code>~resdb_driver.driver.Resdb</code> driver. |
| <a href="classresdb__driver_1_1driver_1_1NamespacedDriver.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for NamespacedDriver:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classresdb__driver_1_1driver_1_1NamespacedDriver.png" usemap="#NamespacedDriver_map" alt=""/> |
| <map id="NamespacedDriver_map" name="NamespacedDriver_map"> |
| <area href="classresdb__driver_1_1driver_1_1AssetsEndpoint.html" title="Exposes functionality of the '/assets' endpoint." alt="AssetsEndpoint" shape="rect" coords="0,56,133,80"/> |
| <area href="classresdb__driver_1_1driver_1_1BlocksEndpoint.html" title="Exposes functionality of the '/blocks' endpoint." alt="BlocksEndpoint" shape="rect" coords="143,56,276,80"/> |
| <area href="classresdb__driver_1_1driver_1_1MetadataEndpoint.html" title="Exposes functionality of the '/metadata' endpoint." alt="MetadataEndpoint" shape="rect" coords="286,56,419,80"/> |
| <area href="classresdb__driver_1_1driver_1_1OutputsEndpoint.html" title="TODO: add endpoint in nodes Exposes functionality of the '/outputs' endpoint." alt="OutputsEndpoint" shape="rect" coords="429,56,562,80"/> |
| <area href="classresdb__driver_1_1driver_1_1TransactionsEndpoint.html" title="Exposes functionality of the '/transactions/' endpoint." alt="TransactionsEndpoint" shape="rect" coords="572,56,705,80"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a2546937b2c011198c7e39541aca153c9" id="r_a2546937b2c011198c7e39541aca153c9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html#a2546937b2c011198c7e39541aca153c9">__init__</a> (self, <a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html">Resdb</a> <a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html#a5752b9eb2786389fa4eea908e15c39c5">driver</a>)</td></tr> |
| <tr class="memdesc:a2546937b2c011198c7e39541aca153c9"><td class="mdescLeft"> </td><td class="mdescRight">Initializes an instance of :class:<code>~resdb_driver.driver.NamespacedDriver</code> with the given driver instance. <br /></td></tr> |
| <tr class="separator:a2546937b2c011198c7e39541aca153c9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a37eacece6bd680ede410c8f7b135ff98" id="r_a37eacece6bd680ede410c8f7b135ff98"><td class="memItemLeft" align="right" valign="top">str </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html#a37eacece6bd680ede410c8f7b135ff98">api_prefix</a> (self)</td></tr> |
| <tr class="separator:a37eacece6bd680ede410c8f7b135ff98"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab73e6efc52ce7a21b22cbf9f3465df91" id="r_ab73e6efc52ce7a21b22cbf9f3465df91"><td class="memItemLeft" align="right" valign="top">str </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html#ab73e6efc52ce7a21b22cbf9f3465df91">path</a> (self)</td></tr> |
| <tr class="separator:ab73e6efc52ce7a21b22cbf9f3465df91"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae71d9b898c84d98291d44b27505b00c1" id="r_ae71d9b898c84d98291d44b27505b00c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classresdb__driver_1_1transport_1_1Transport.html">Transport</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html#ae71d9b898c84d98291d44b27505b00c1">transport</a> (self)</td></tr> |
| <tr class="separator:ae71d9b898c84d98291d44b27505b00c1"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:a5752b9eb2786389fa4eea908e15c39c5" id="r_a5752b9eb2786389fa4eea908e15c39c5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html#a5752b9eb2786389fa4eea908e15c39c5">driver</a></td></tr> |
| <tr class="separator:a5752b9eb2786389fa4eea908e15c39c5"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr class="memitem:a62345317491758a93722c16ba442b023" id="r_a62345317491758a93722c16ba442b023"><td class="memItemLeft" align="right" valign="top">str </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html#a62345317491758a93722c16ba442b023">PATH</a> = "/"</td></tr> |
| <tr class="separator:a62345317491758a93722c16ba442b023"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Base class for creating endpoints (namespaced objects) that can be added under the :class:<code>~resdb_driver.driver.Resdb</code> driver. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a2546937b2c011198c7e39541aca153c9" name="a2546937b2c011198c7e39541aca153c9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2546937b2c011198c7e39541aca153c9">◆ </a></span>__init__()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">__init__ </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>self</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html">Resdb</a> </td> |
| <td class="paramname"><em>driver</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initializes an instance of :class:<code>~resdb_driver.driver.NamespacedDriver</code> with the given driver instance. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">driver</td><td>(Resdb): Instance of :class:<code>~resdb_driver.driver.Resdb</code>.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>An instance of the NamespacedDriver class. </dd></dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a37eacece6bd680ede410c8f7b135ff98" name="a37eacece6bd680ede410c8f7b135ff98"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a37eacece6bd680ede410c8f7b135ff98">◆ </a></span>api_prefix()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"> str api_prefix </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>self</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="ab73e6efc52ce7a21b22cbf9f3465df91" name="ab73e6efc52ce7a21b22cbf9f3465df91"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab73e6efc52ce7a21b22cbf9f3465df91">◆ </a></span>path()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"> str path </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>self</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="ae71d9b898c84d98291d44b27505b00c1" name="ae71d9b898c84d98291d44b27505b00c1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae71d9b898c84d98291d44b27505b00c1">◆ </a></span>transport()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"> <a class="el" href="classresdb__driver_1_1transport_1_1Transport.html">Transport</a> transport </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>self</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="a5752b9eb2786389fa4eea908e15c39c5" name="a5752b9eb2786389fa4eea908e15c39c5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5752b9eb2786389fa4eea908e15c39c5">◆ </a></span>driver</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">driver</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a62345317491758a93722c16ba442b023" name="a62345317491758a93722c16ba442b023"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a62345317491758a93722c16ba442b023">◆ </a></span>PATH</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">str PATH = "/"</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</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>/github/workspace/resdb_driver/<a class="el" href="driver_8py.html">driver.py</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceresdb__driver.html">resdb_driver</a></li><li class="navelem"><a class="el" href="namespaceresdb__driver_1_1driver.html">driver</a></li><li class="navelem"><a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html">NamespacedDriver</a></li> |
| <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
