cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-24 21:46:52 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
tgstation-server/_topic_response_8cs_source.html
T

131 lines
19 KiB
HTML
Raw Permalink 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" 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>tgstation-server: src/Tgstation.Server.Host/Components/Interop/Topic/TopicResponse.cs Source File</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 id="projectrow">
<td id="projectalign">
<div id="projectname">tgstation-server<span id="projectnumber">&#160;6.19.3</span>
</div>
<div id="projectbrief">The /tg/station 13 server suite</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_34761767c1c3cd212f9d2f80ea0828a8.html">Tgstation.Server.Host</a></li><li class="navelem"><a class="el" href="dir_7a3fd032a1362a6005a1fc9227a8dd86.html">Components</a></li><li class="navelem"><a class="el" href="dir_0f5073360b9ba6d1522457c65eebe36a.html">Interop</a></li><li class="navelem"><a class="el" href="dir_935188fa6520fafdbdb4920911a885bd.html">Topic</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">TopicResponse.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_topic_response_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="keyword">using </span>System.Collections.Generic;</div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_chat_1_1_commands.html">Tgstation.Server.Host.Components.Chat.Commands</a>;</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic.html">Tgstation.Server.Host.Components.Interop.Topic</a></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span>{</div>
<div class="foldopen" id="foldopen00010" data-start="{" data-end="};">
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html"> 10</a></span> <span class="keyword">sealed</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html">TopicResponse</a> : <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_d_m_api_response.html">DMApiResponse</a>, <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_i_missing_payloads_communication.html">IMissingPayloadsCommunication</a></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> {</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a5ed4fe71c0032e219bc3fb246afee855"> 15</a></span> <span class="keyword">public</span> <span class="keywordtype">string</span>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a5ed4fe71c0032e219bc3fb246afee855">CommandResponseMessage</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a6a47426c754c0585e8dff44b5f726df9"> 20</a></span> <span class="keyword">public</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_chat_message.html">ChatMessage</a>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a6a47426c754c0585e8dff44b5f726df9">CommandResponse</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a2232f10dafaa3d6ec82fb05e1639841c"> 25</a></span> <span class="keyword">public</span> ICollection&lt;ChatMessage&gt;? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a2232f10dafaa3d6ec82fb05e1639841c">ChatResponses</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#ae59db0e8ee1e990d0f630fc58a330210"> 30</a></span> <span class="keyword">public</span> ICollection&lt;CustomCommand&gt;? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#ae59db0e8ee1e990d0f630fc58a330210">CustomCommands</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a34261fa33d1e11fc658cd35fe64e5a5c"> 35</a></span> <span class="keyword">public</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_chunk_data.html">ChunkData</a>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a34261fa33d1e11fc658cd35fe64e5a5c">Chunk</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a49ad5ec3d1b3d4cc27b178c34c11061a"> 38</a></span> <span class="keyword">public</span> IReadOnlyCollection&lt;uint&gt;? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a49ad5ec3d1b3d4cc27b178c34c11061a">MissingChunks</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a5026b62a251608787027996867e024e0"> 43</a></span> <span class="keyword">public</span> uint? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a5026b62a251608787027996867e024e0">ClientCount</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> }</div>
</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_chat_message_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_chat_message.html">Tgstation.Server.Host.Components.Interop.ChatMessage</a></div><div class="ttdoc">Represents a message to send to one or more Chat.ChannelRepresentations.</div><div class="ttdef"><b>Definition</b> <a href="_chat_message_8cs_source.html#l00008">ChatMessage.cs:9</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_chunk_data_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_chunk_data.html">Tgstation.Server.Host.Components.Interop.ChunkData</a></div><div class="ttdoc">A packet of a split serialized set of data.</div><div class="ttdef"><b>Definition</b> <a href="_chunk_data_8cs_source.html#l00006">ChunkData.cs:7</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_d_m_api_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_d_m_api_response.html">Tgstation.Server.Host.Components.Interop.DMApiResponse</a></div><div class="ttdoc">Common base for interop responses.</div><div class="ttdef"><b>Definition</b> <a href="_d_m_api_response_8cs_source.html#l00006">DMApiResponse.cs:7</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html">Tgstation.Server.Host.Components.Interop.Topic.TopicResponse</a></div><div class="ttdoc">A response to a topic request.</div><div class="ttdef"><b>Definition</b> <a href="_topic_response_8cs_source.html#l00010">TopicResponse.cs:11</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response_html_a2232f10dafaa3d6ec82fb05e1639841c"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a2232f10dafaa3d6ec82fb05e1639841c">Tgstation.Server.Host.Components.Interop.Topic.TopicResponse.ChatResponses</a></div><div class="ttdeci">ICollection&lt; ChatMessage &gt;? ChatResponses</div><div class="ttdoc">The ChatMessages to send as the result of a TopicCommandType.EventNotification request,...</div><div class="ttdef"><b>Definition</b> <a href="_topic_response_8cs_source.html#l00025">TopicResponse.cs:25</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response_html_a34261fa33d1e11fc658cd35fe64e5a5c"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a34261fa33d1e11fc658cd35fe64e5a5c">Tgstation.Server.Host.Components.Interop.Topic.TopicResponse.Chunk</a></div><div class="ttdeci">ChunkData? Chunk</div><div class="ttdoc">The ChunkData for a partial response.</div><div class="ttdef"><b>Definition</b> <a href="_topic_response_8cs_source.html#l00035">TopicResponse.cs:35</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response_html_a49ad5ec3d1b3d4cc27b178c34c11061a"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a49ad5ec3d1b3d4cc27b178c34c11061a">Tgstation.Server.Host.Components.Interop.Topic.TopicResponse.MissingChunks</a></div><div class="ttdeci">IReadOnlyCollection&lt; uint &gt;? MissingChunks</div><div class="ttdoc">The ChunkData.SequenceIds missing from a chunked request.</div><div class="ttdef"><b>Definition</b> <a href="_topic_response_8cs_source.html#l00038">TopicResponse.cs:38</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response_html_a5026b62a251608787027996867e024e0"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a5026b62a251608787027996867e024e0">Tgstation.Server.Host.Components.Interop.Topic.TopicResponse.ClientCount</a></div><div class="ttdeci">uint? ClientCount</div><div class="ttdoc">The number of connected clients to the game. Added in Interop 5.10.0.</div><div class="ttdef"><b>Definition</b> <a href="_topic_response_8cs_source.html#l00043">TopicResponse.cs:43</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response_html_a5ed4fe71c0032e219bc3fb246afee855"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a5ed4fe71c0032e219bc3fb246afee855">Tgstation.Server.Host.Components.Interop.Topic.TopicResponse.CommandResponseMessage</a></div><div class="ttdeci">string? CommandResponseMessage</div><div class="ttdoc">The text to reply with as the result of a TopicCommandType.ChatCommand request, if any....</div><div class="ttdef"><b>Definition</b> <a href="_topic_response_8cs_source.html#l00015">TopicResponse.cs:15</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response_html_a6a47426c754c0585e8dff44b5f726df9"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#a6a47426c754c0585e8dff44b5f726df9">Tgstation.Server.Host.Components.Interop.Topic.TopicResponse.CommandResponse</a></div><div class="ttdeci">ChatMessage? CommandResponse</div><div class="ttdoc">The ChatMessage response from a ChatCommand. Added in Interop 5.4.0.</div><div class="ttdef"><b>Definition</b> <a href="_topic_response_8cs_source.html#l00020">TopicResponse.cs:20</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response_html_ae59db0e8ee1e990d0f630fc58a330210"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_1_1_topic_response.html#ae59db0e8ee1e990d0f630fc58a330210">Tgstation.Server.Host.Components.Interop.Topic.TopicResponse.CustomCommands</a></div><div class="ttdeci">ICollection&lt; CustomCommand &gt;? CustomCommands</div><div class="ttdoc">The DMAPI CustomCommands for TopicCommandType.ServerRestarted requests.</div><div class="ttdef"><b>Definition</b> <a href="_topic_response_8cs_source.html#l00030">TopicResponse.cs:30</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_i_missing_payloads_communication_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_i_missing_payloads_communication.html">Tgstation.Server.Host.Components.Interop.IMissingPayloadsCommunication</a></div><div class="ttdoc">A communication that can be missing chunk payloads.</div><div class="ttdef"><b>Definition</b> <a href="_i_missing_payloads_communication_8cs_source.html#l00008">IMissingPayloadsCommunication.cs:9</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_chat_1_1_commands_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_chat_1_1_commands.html">Tgstation.Server.Host.Components.Chat.Commands</a></div><div class="ttdef"><b>Definition</b> <a href="_command_factory_8cs_source.html#l00011">CommandFactory.cs:12</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_interop_1_1_topic.html">Tgstation.Server.Host.Components.Interop.Topic</a></div><div class="ttdef"><b>Definition</b> <a href="_chat_command_8cs_source.html#l00005">ChatCommand.cs:6</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink