263 lines
9.9 KiB
HTML
263 lines
9.9 KiB
HTML
|
<!DOCTYPE html>
|
|||
|
|
<!--[if IE]><![endif]-->
|
|||
|
|
<html>
|
|||
|
|
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|||
|
|
<title>Class Server
|
|||
|
|
| RageCoop resource documentation </title>
|
|||
|
|
<meta name="viewport" content="width=device-width">
|
|||
|
|
<meta name="title" content="Class Server
|
|||
|
|
| RageCoop resource documentation ">
|
|||
|
|
<meta name="generator" content="docfx 2.59.2.0">
|
|||
|
|
|
|||
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|||
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|||
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|||
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|||
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|||
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|||
|
|
|
|||
|
|
<meta property="docfx:rel" content="../">
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|||
|
|
<div id="wrapper">
|
|||
|
|
<header>
|
|||
|
|
|
|||
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|||
|
|
<div class="container">
|
|||
|
|
<div class="navbar-header">
|
|||
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|||
|
|
<span class="sr-only">Toggle navigation</span>
|
|||
|
|
<span class="icon-bar"></span>
|
|||
|
|
<span class="icon-bar"></span>
|
|||
|
|
<span class="icon-bar"></span>
|
|||
|
|
</button>
|
|||
|
|
|
|||
|
|
<a class="navbar-brand" href="../index.html">
|
|||
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|||
|
|
</a>
|
|||
|
|
</div>
|
|||
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|||
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|||
|
|
<div class="form-group">
|
|||
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<div class="subnav navbar navbar-default">
|
|||
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|||
|
|
<ul class="breadcrumb">
|
|||
|
|
<li></li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</header>
|
|||
|
|
<div class="container body-content">
|
|||
|
|
|
|||
|
|
<div id="search-results">
|
|||
|
|
<div class="search-list">Search Results for <span></span></div>
|
|||
|
|
<div class="sr-items">
|
|||
|
|
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
|
|||
|
|
</div>
|
|||
|
|
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div role="main" class="container body-content hide-when-search">
|
|||
|
|
|
|||
|
|
<div class="sidenav hide-when-search">
|
|||
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|||
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|||
|
|
<div id="sidetoc"></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="article row grid-right">
|
|||
|
|
<div class="col-md-10">
|
|||
|
|
<article class="content wrap" id="_content" data-uid="RageCoop.Server.Server">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<h1 id="RageCoop_Server_Server" data-uid="RageCoop.Server.Server" class="text-break">Class Server
|
|||
|
|
</h1>
|
|||
|
|
<div class="markdown level0 summary"><p>The instantiable RageCoop server class</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="markdown level0 conceptual"></div>
|
|||
|
|
<div class="inheritance">
|
|||
|
|
<h5>Inheritance</h5>
|
|||
|
|
<div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
|
|||
|
|
<div class="level1"><span class="xref">Server</span></div>
|
|||
|
|
</div>
|
|||
|
|
<div class="inheritedMembers">
|
|||
|
|
<h5>Inherited Members</h5>
|
|||
|
|
<div>
|
|||
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">Object.Equals(Object)</a>
|
|||
|
|
</div>
|
|||
|
|
<div>
|
|||
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">Object.Equals(Object, Object)</a>
|
|||
|
|
</div>
|
|||
|
|
<div>
|
|||
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#system-object-gethashcode">Object.GetHashCode()</a>
|
|||
|
|
</div>
|
|||
|
|
<div>
|
|||
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#system-object-gettype">Object.GetType()</a>
|
|||
|
|
</div>
|
|||
|
|
<div>
|
|||
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#system-object-memberwiseclone">Object.MemberwiseClone()</a>
|
|||
|
|
</div>
|
|||
|
|
<div>
|
|||
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.referenceequals#system-object-referenceequals(system-object-system-object)">Object.ReferenceEquals(Object, Object)</a>
|
|||
|
|
</div>
|
|||
|
|
<div>
|
|||
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#system-object-tostring">Object.ToString()</a>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="RageCoop.Server.html">RageCoop.Server</a></h6>
|
|||
|
|
<h6><strong>Assembly</strong>: RageCoop.Server.dll</h6>
|
|||
|
|
<h5 id="RageCoop_Server_Server_syntax">Syntax</h5>
|
|||
|
|
<div class="codewrapper">
|
|||
|
|
<pre><code class="lang-csharp hljs">public class Server</code></pre>
|
|||
|
|
</div>
|
|||
|
|
<h3 id="constructors">Constructors
|
|||
|
|
</h3>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a id="RageCoop_Server_Server__ctor_" data-uid="RageCoop.Server.Server.#ctor*"></a>
|
|||
|
|
<h4 id="RageCoop_Server_Server__ctor_RageCoop_Server_ServerSettings_RageCoop_Core_Logger_" data-uid="RageCoop.Server.Server.#ctor(RageCoop.Server.ServerSettings,RageCoop.Core.Logger)">Server(ServerSettings, Logger)</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Instantiate a server.</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="markdown level1 conceptual"></div>
|
|||
|
|
<h5 class="decalaration">Declaration</h5>
|
|||
|
|
<div class="codewrapper">
|
|||
|
|
<pre><code class="lang-csharp hljs">public Server(ServerSettings settings, Logger logger = null)</code></pre>
|
|||
|
|
</div>
|
|||
|
|
<h5 class="parameters">Parameters</h5>
|
|||
|
|
<table class="table table-bordered table-striped table-condensed">
|
|||
|
|
<thead>
|
|||
|
|
<tr>
|
|||
|
|
<th>Type</th>
|
|||
|
|
<th>Name</th>
|
|||
|
|
<th>Description</th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="RageCoop.Server.ServerSettings.html">ServerSettings</a></td>
|
|||
|
|
<td><span class="parametername">settings</span></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="RageCoop.Core.Logger.html">Logger</a></td>
|
|||
|
|
<td><span class="parametername">logger</span></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
<h5 class="exceptions">Exceptions</h5>
|
|||
|
|
<table class="table table-bordered table-striped table-condensed">
|
|||
|
|
<thead>
|
|||
|
|
<tr>
|
|||
|
|
<th>Type</th>
|
|||
|
|
<th>Condition</th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
<h3 id="properties">Properties
|
|||
|
|
</h3>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a id="RageCoop_Server_Server_API_" data-uid="RageCoop.Server.Server.API*"></a>
|
|||
|
|
<h4 id="RageCoop_Server_Server_API" data-uid="RageCoop.Server.Server.API">API</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>The API for controlling server and hooking events.</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="markdown level1 conceptual"></div>
|
|||
|
|
<h5 class="decalaration">Declaration</h5>
|
|||
|
|
<div class="codewrapper">
|
|||
|
|
<pre><code class="lang-csharp hljs">public API API { get; }</code></pre>
|
|||
|
|
</div>
|
|||
|
|
<h5 class="propertyValue">Property Value</h5>
|
|||
|
|
<table class="table table-bordered table-striped table-condensed">
|
|||
|
|
<thead>
|
|||
|
|
<tr>
|
|||
|
|
<th>Type</th>
|
|||
|
|
<th>Description</th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="RageCoop.Server.Scripting.API.html">API</a></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
<h3 id="methods">Methods
|
|||
|
|
</h3>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a id="RageCoop_Server_Server_Start_" data-uid="RageCoop.Server.Server.Start*"></a>
|
|||
|
|
<h4 id="RageCoop_Server_Server_Start" data-uid="RageCoop.Server.Server.Start">Start()</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Spawn threads and start the server</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="markdown level1 conceptual"></div>
|
|||
|
|
<h5 class="decalaration">Declaration</h5>
|
|||
|
|
<div class="codewrapper">
|
|||
|
|
<pre><code class="lang-csharp hljs">public void Start()</code></pre>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a id="RageCoop_Server_Server_Stop_" data-uid="RageCoop.Server.Server.Stop*"></a>
|
|||
|
|
<h4 id="RageCoop_Server_Server_Stop" data-uid="RageCoop.Server.Server.Stop">Stop()</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Terminate threads and stop the server</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="markdown level1 conceptual"></div>
|
|||
|
|
<h5 class="decalaration">Declaration</h5>
|
|||
|
|
<div class="codewrapper">
|
|||
|
|
<pre><code class="lang-csharp hljs">public void Stop()</code></pre>
|
|||
|
|
</div>
|
|||
|
|
</article>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|||
|
|
<div class="sideaffix">
|
|||
|
|
<div class="contribution">
|
|||
|
|
<ul class="nav">
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|||
|
|
<h5>In This Article</h5>
|
|||
|
|
<div></div>
|
|||
|
|
</nav>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<footer>
|
|||
|
|
<div class="grad-bottom"></div>
|
|||
|
|
<div class="footer">
|
|||
|
|
<div class="container">
|
|||
|
|
<span class="pull-right">
|
|||
|
|
<a href="#top">Back to top</a>
|
|||
|
|
</span>
|
|||
|
|
|
|||
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</footer>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|||
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|||
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|