Deploying to gh-pages from @ 632ec6a 🚀

googleforgames · Nov 28, 2024 · 621d351 · 621d351
1 parent 2aa7adf
commit 621d351
Show file tree

Hide file tree

Showing 62 changed files with 477 additions and 589 deletions.
diff --git a/main/api/qt/enum.PailConfig.html b/main/api/qt/enum.PailConfig.html
diff --git a/main/api/quilkin/all.html b/main/api/quilkin/all.html
diff --git a/main/api/quilkin/cli/enum.LogFormats.html b/main/api/quilkin/cli/enum.LogFormats.html
diff --git a/main/api/quilkin/codec/qcmp/enum.Error.html b/main/api/quilkin/codec/qcmp/enum.Error.html
diff --git a/main/api/quilkin/components/proxy/index.html b/main/api/quilkin/components/proxy/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `proxy` mod in crate `quilkin`."><title>quilkin::components::proxy - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-c5d6553a23f1e5a6.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="quilkin" data-themes="" data-resource-suffix="" data-rustdoc-version="1.81.0 (eeb90cda1 2024-09-04)" data-channel="1.81.0" data-search-js="search-d234aafac6c221dd.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-d2fab2bf619172d3.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../quilkin/index.html">quilkin</a><span class="version">0.10.0-dev</span></h2></div><h2 class="location"><a href="#">Module proxy</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In quilkin::components</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../../index.html">quilkin</a>::<wbr><a href="../index.html">components</a>::<wbr><a class="mod" href="#">proxy</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../../src/quilkin/components/proxy.rs.html#17-341">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="packet_router/index.html" title="mod quilkin::components::proxy::packet_router">packet_router</a></div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Proxy.html" title="struct quilkin::components::proxy::Proxy">Proxy</a></div></li><li><div class="item-name"><a class="struct" href="struct.Ready.html" title="struct quilkin::components::proxy::Ready">Ready</a></div></li><li><div class="item-name"><a class="struct" href="struct.RecvPacket.html" title="struct quilkin::components::proxy::RecvPacket">RecvPacket</a></div></li><li><div class="item-name"><a class="struct" href="struct.SendPacket.html" title="struct quilkin::components::proxy::SendPacket">SendPacket</a></div></li><li><div class="item-name"><a class="struct" href="struct.SessionPool.html" title="struct quilkin::components::proxy::SessionPool">SessionPool</a></div><div class="desc docblock-short">A data structure that is responsible for holding sessions, and pooling
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `proxy` mod in crate `quilkin`."><title>quilkin::components::proxy - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-c5d6553a23f1e5a6.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="quilkin" data-themes="" data-resource-suffix="" data-rustdoc-version="1.81.0 (eeb90cda1 2024-09-04)" data-channel="1.81.0" data-search-js="search-d234aafac6c221dd.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-d2fab2bf619172d3.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../quilkin/index.html">quilkin</a><span class="version">0.10.0-dev</span></h2></div><h2 class="location"><a href="#">Module proxy</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In quilkin::components</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../../index.html">quilkin</a>::<wbr><a href="../index.html">components</a>::<wbr><a class="mod" href="#">proxy</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../../src/quilkin/components/proxy.rs.html#17-402">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="packet_router/index.html" title="mod quilkin::components::proxy::packet_router">packet_router</a></div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.PendingSends.html" title="struct quilkin::components::proxy::PendingSends">PendingSends</a></div><div class="desc docblock-short">A simple packet queue that signals when a packet is pushed</div></li><li><div class="item-name"><a class="struct" href="struct.Proxy.html" title="struct quilkin::components::proxy::Proxy">Proxy</a></div></li><li><div class="item-name"><a class="struct" href="struct.Ready.html" title="struct quilkin::components::proxy::Ready">Ready</a></div></li><li><div class="item-name"><a class="struct" href="struct.RecvPacket.html" title="struct quilkin::components::proxy::RecvPacket">RecvPacket</a></div></li><li><div class="item-name"><a class="struct" href="struct.SendPacket.html" title="struct quilkin::components::proxy::SendPacket">SendPacket</a></div></li><li><div class="item-name"><a class="struct" href="struct.SessionPool.html" title="struct quilkin::components::proxy::SessionPool">SessionPool</a></div><div class="desc docblock-short">A data structure that is responsible for holding sessions, and pooling
 sockets between them. This means that we only provide new unique sockets
 to new connections to the same gameserver, and we share sockets across
 multiple gameservers.</div></li><li><div class="item-name"><a class="struct" href="struct.ToTokens.html" title="struct quilkin::components::proxy::ToTokens">ToTokens</a></div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.PipelineError.html" title="enum quilkin::components::proxy::PipelineError">PipelineError</a></div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.ErrorMap.html" title="type quilkin::components::proxy::ErrorMap">ErrorMap</a></div></li></ul></section></div></main></body></html>
diff --git a/main/api/quilkin/components/proxy/packet_router/fn.spawn_receivers.html b/main/api/quilkin/components/proxy/packet_router/fn.spawn_receivers.html
@@ -1,12 +1,10 @@
-<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Spawns a background task that sits in a loop, receiving packets from the passed in socket. Each received packet is placed on a queue to be processed by a worker task. This function also spawns the set of worker tasks responsible for consuming packets off the aforementioned queue and processing them through the filter chain and session pipeline."><title>spawn_receivers in quilkin::components::proxy::packet_router - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-c5d6553a23f1e5a6.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="quilkin" data-themes="" data-resource-suffix="" data-rustdoc-version="1.81.0 (eeb90cda1 2024-09-04)" data-channel="1.81.0" data-search-js="search-d234aafac6c221dd.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../../static.files/main-d2fab2bf619172d3.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../quilkin/index.html">quilkin</a><span class="version">0.10.0-dev</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In quilkin::components::proxy::packet_router</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../../../index.html">quilkin</a>::<wbr><a href="../../index.html">components</a>::<wbr><a href="../index.html">proxy</a>::<wbr><a href="index.html">packet_router</a>::<wbr><a class="fn" href="#">spawn_receivers</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../../../src/quilkin/components/proxy/packet_router.rs.html#137-201">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub async fn spawn_receivers(
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Spawns a background task that sits in a loop, receiving packets from the passed in socket. Each received packet is placed on a queue to be processed by a worker task. This function also spawns the set of worker tasks responsible for consuming packets off the aforementioned queue and processing them through the filter chain and session pipeline."><title>spawn_receivers in quilkin::components::proxy::packet_router - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-c5d6553a23f1e5a6.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="quilkin" data-themes="" data-resource-suffix="" data-rustdoc-version="1.81.0 (eeb90cda1 2024-09-04)" data-channel="1.81.0" data-search-js="search-d234aafac6c221dd.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../../static.files/main-d2fab2bf619172d3.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../quilkin/index.html">quilkin</a><span class="version">0.10.0-dev</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In quilkin::components::proxy::packet_router</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../../../index.html">quilkin</a>::<wbr><a href="../../index.html">components</a>::<wbr><a href="../index.html">proxy</a>::<wbr><a href="index.html">packet_router</a>::<wbr><a class="fn" href="#">spawn_receivers</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../../../src/quilkin/components/proxy/packet_router.rs.html#132-192">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub async fn spawn_receivers(
     config: <a class="struct" href="https://doc.rust-lang.org/1.81.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;<a class="struct" href="../../../struct.Config.html" title="struct quilkin::Config">Config</a>&gt;,
     socket: Socket,
-    num_workers: <a class="primitive" href="https://doc.rust-lang.org/1.81.0/std/primitive.usize.html">usize</a>,
+    worker_sends: <a class="struct" href="https://doc.rust-lang.org/1.81.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;(<a class="struct" href="../struct.PendingSends.html" title="struct quilkin::components::proxy::PendingSends">PendingSends</a>, EventFd)&gt;,
     sessions: &amp;<a class="struct" href="https://doc.rust-lang.org/1.81.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;<a class="struct" href="../struct.SessionPool.html" title="struct quilkin::components::proxy::SessionPool">SessionPool</a>&gt;,
-    upstream_receiver: Receiver&lt;<a class="struct" href="../struct.SendPacket.html" title="struct quilkin::components::proxy::SendPacket">SendPacket</a>&gt;,
     buffer_pool: <a class="struct" href="https://doc.rust-lang.org/1.81.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;<a class="struct" href="../../../pool/struct.BufferPool.html" title="struct quilkin::pool::BufferPool">BufferPool</a>&gt;,
-    shutdown: <a class="type" href="../../../type.ShutdownRx.html" title="type quilkin::ShutdownRx">ShutdownRx</a>,
-) -&gt; <a class="type" href="../../../type.Result.html" title="type quilkin::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.81.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.81.0/std/sync/mpsc/struct.Receiver.html" title="struct std::sync::mpsc::Receiver">Receiver</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.81.0/std/primitive.unit.html">()</a>&gt;&gt;&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Spawns a background task that sits in a loop, receiving packets from the passed in socket.
+) -&gt; <a class="type" href="../../../type.Result.html" title="type quilkin::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.81.0/std/primitive.unit.html">()</a>&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Spawns a background task that sits in a loop, receiving packets from the passed in socket.
 Each received packet is placed on a queue to be processed by a worker task.
 This function also spawns the set of worker tasks responsible for consuming packets
 off the aforementioned queue and processing them through the filter chain and session