ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-26 22:15:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
a84d06b17d69754eb8af364182d5865ac35a05bc
rippled/classripple_1_1Server.html
nbougalis 4ad595bf18 deploy: 020b285808
2020-04-15 21:15:02 +00:00

237 lines
12 KiB
HTML
Raw Blame History

<!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::Server 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_1Server.html">Server</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classripple_1_1Server-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::Server Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A multi-protocol server.
<a href="classripple_1_1Server.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for ripple::Server:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1Server__inherit__graph.png" border="0" usemap="#ripple_1_1Server_inherit__map" alt="Inheritance graph"/></div>
<map name="ripple_1_1Server_inherit__map" id="ripple_1_1Server_inherit__map">
<area shape="rect" title="A multi&#45;protocol server." alt="" coords="20,5,129,32"/>
<area shape="rect" href="classripple_1_1ServerImpl.html" title=" " alt="" coords="5,80,144,121"/>
</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-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a47a7a65d04eca040324d978e224ae25d"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Server.html#a47a7a65d04eca040324d978e224ae25d">~Server</a> ()=default</td></tr>
<tr class="memdesc:a47a7a65d04eca040324d978e224ae25d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the server. <a href="classripple_1_1Server.html#a47a7a65d04eca040324d978e224ae25d">More...</a><br /></td></tr>
<tr class="separator:a47a7a65d04eca040324d978e224ae25d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a984892293a31d9200217b6a3dd1e07"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Server.html#a6a984892293a31d9200217b6a3dd1e07">journal</a> ()=0</td></tr>
<tr class="memdesc:a6a984892293a31d9200217b6a3dd1e07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the Journal associated with the server. <a href="classripple_1_1Server.html#a6a984892293a31d9200217b6a3dd1e07">More...</a><br /></td></tr>
<tr class="separator:a6a984892293a31d9200217b6a3dd1e07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a132e76325036846794780c22431f78c7"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceripple.html#a07b86307adf32095f4693b7b5e7d4b98">Endpoints</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Server.html#a132e76325036846794780c22431f78c7">ports</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="el" href="structripple_1_1Port.html">Port</a> &gt; const &amp;v)=0</td></tr>
<tr class="memdesc:a132e76325036846794780c22431f78c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the listening port settings. <a href="classripple_1_1Server.html#a132e76325036846794780c22431f78c7">More...</a><br /></td></tr>
<tr class="separator:a132e76325036846794780c22431f78c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a022b4bd53b1eda3db97e404f90b31e4e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Server.html#a022b4bd53b1eda3db97e404f90b31e4e">close</a> ()=0</td></tr>
<tr class="memdesc:a022b4bd53b1eda3db97e404f90b31e4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the server. <a href="classripple_1_1Server.html#a022b4bd53b1eda3db97e404f90b31e4e">More...</a><br /></td></tr>
<tr class="separator:a022b4bd53b1eda3db97e404f90b31e4e"><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>A multi-protocol server. </p>
<p>This server maintains multiple configured listening ports, with each listening port allows for multiple protocols including HTTP, HTTP/S, WebSocket, Secure WebSocket, and the <a class="el" href="classripple_1_1Peer.html" title="Represents a peer connection in the overlay.">Peer</a> protocol. </p>
<p class="definition">Definition at line <a class="el" href="ServerImpl_8h_source.html#l00044">44</a> of file <a class="el" href="ServerImpl_8h_source.html">ServerImpl.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a47a7a65d04eca040324d978e224ae25d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47a7a65d04eca040324d978e224ae25d">&#9670;&nbsp;</a></span>~Server()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ripple::Server::~Server </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy the server. </p>
<p>The server is closed if it is not already closed. This call blocks until the server has stopped. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6a984892293a31d9200217b6a3dd1e07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a984892293a31d9200217b6a3dd1e07">&#9670;&nbsp;</a></span>journal()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> ripple::Server::journal </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the Journal associated with the server. </p>
<p>Implemented in <a class="el" href="classripple_1_1ServerImpl.html#ab56061fcb6bb1d06451af082c3bdf8a0">ripple::ServerImpl&lt; Handler &gt;</a>.</p>
</div>
</div>
<a id="a132e76325036846794780c22431f78c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a132e76325036846794780c22431f78c7">&#9670;&nbsp;</a></span>ports()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceripple.html#a07b86307adf32095f4693b7b5e7d4b98">Endpoints</a> ripple::Server::ports </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="el" href="structripple_1_1Port.html">Port</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the listening port settings. </p>
<p>This may only be called once. </p>
<p>Implemented in <a class="el" href="classripple_1_1ServerImpl.html#adfd8ae8449f7ceea13448c876af52741">ripple::ServerImpl&lt; Handler &gt;</a>.</p>
</div>
</div>
<a id="a022b4bd53b1eda3db97e404f90b31e4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a022b4bd53b1eda3db97e404f90b31e4e">&#9670;&nbsp;</a></span>close()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::Server::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the server. </p>
<p>The close is performed asynchronously. The handler will be notified when the server has stopped. The server is considered stopped when there are no pending I/O completion handlers and all connections have closed. Thread safety: Safe to call concurrently from any thread. </p>
<p>Implemented in <a class="el" href="classripple_1_1ServerImpl.html#a6b32ac32433b2227c36b762fb195ec5d">ripple::ServerImpl&lt; Handler &gt;</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>
Reference in New Issue View Git Blame Copy Permalink