mirror of
https://github.com/LiteyukiStudio/LiteyukiBot.git
synced 2024-11-15 14:24:24 +08:00
52 lines
42 KiB
HTML
52 lines
42 KiB
HTML
|
<!doctype html>
|
|||
|
|
<html lang="en-US" data-theme="light">
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8" />
|
|||
|
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
|||
|
|
<meta name="generator" content="VuePress 2.0.0-rc.9" />
|
|||
|
|
<meta name="theme" content="VuePress Theme Hope 2.0.0-rc.32" />
|
|||
|
|
<style>
|
|||
|
|
html {
|
|||
|
|
background: var(--bg-color, #fff);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
html[data-theme="dark"] {
|
|||
|
|
background: var(--bg-color, #1d1e1f);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
body {
|
|||
|
|
background: var(--bg-color);
|
|||
|
|
}
|
|||
|
|
</style>
|
|||
|
|
<script>
|
|||
|
|
const userMode = localStorage.getItem("vuepress-theme-hope-scheme");
|
|||
|
|
const systemDarkMode =
|
|||
|
|
window.matchMedia &&
|
|||
|
|
window.matchMedia("(prefers-color-scheme: dark)").matches;
|
|||
|
|
|
|||
|
|
if (userMode === "dark" || (userMode !== "light" && systemDarkMode)) {
|
|||
|
|
document.documentElement.setAttribute("data-theme", "dark");
|
|||
|
|
}
|
|||
|
|
</script>
|
|||
|
|
<link rel="alternate" hreflang="zh-cn" href="https://vuepress-theme-hope-docs-demo.netlify.app/dev/api/comm/channel.html"><meta property="og:url" content="https://vuepress-theme-hope-docs-demo.netlify.app/en/dev/api/comm/channel.html"><meta property="og:site_name" content="LiteyukiBot"><meta property="og:title" content="liteyuki.comm.channel"><meta property="og:description" content="def set_channel(name: str, channel: Channel) -> None 设置通道实例 Args: def set_channels(channels: dict[str, Channel]) -> None 设置通道实例 Args: def get_channel(name: str) -> Channel 获取通道实..."><meta property="og:type" content="article"><meta property="og:locale" content="en-US"><meta property="og:locale:alternate" content="zh-CN"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"liteyuki.comm.channel","image":[""],"dateModified":null,"author":[]}</script><script src="/js/en/get_data.js" type="module"></script><script src="/js/style.js" type="module"></script><link rel="icon" href="https://cdn.liteyuki.icu/favicon.ico"><link rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/firacode/6.2.0/fira_code.min.css"><meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"><title>liteyuki.comm.channel | LiteyukiBot</title><meta name="description" content="def set_channel(name: str, channel: Channel) -> None 设置通道实例 Args: def set_channels(channels: dict[str, Channel]) -> None 设置通道实例 Args: def get_channel(name: str) -> Channel 获取通道实...">
|
|||
|
|
<link rel="preload" href="/assets/style-CSEr-Ojo.css" as="style"><link rel="stylesheet" href="/assets/style-CSEr-Ojo.css">
|
|||
|
|
<link rel="modulepreload" href="/assets/app-Dk7jq3Nw.js"><link rel="modulepreload" href="/assets/channel.html-DXoOXy_-.js">
|
|||
|
|
<link rel="prefetch" href="/assets/index.html-CuXU0C96.js" as="script"><link rel="prefetch" href="/assets/index.html-C5oeF3SG.js" as="script"><link rel="prefetch" href="/assets/config.html-DfRw-mfz.js" as="script"><link rel="prefetch" href="/assets/fandq.html-CgO_6NNf.js" as="script"><link rel="prefetch" href="/assets/install.html-Bo_lLi1B.js" as="script"><link rel="prefetch" href="/assets/index.html-gN2Qu4Pv.js" as="script"><link rel="prefetch" href="/assets/dev_comm.html-DGUkd71K.js" as="script"><link rel="prefetch" href="/assets/dev_lyfunc.html-BXHxmyTR.js" as="script"><link rel="prefetch" href="/assets/dev_lyplugin.html-CsQIG1i9.js" as="script"><link rel="prefetch" href="/assets/dev_resource_pack.html-NGauvPHe.js" as="script"><link rel="prefetch" href="/assets/index.html-C1KTa-Fn.js" as="script"><link rel="prefetch" href="/assets/index.html-CYBwTRlH.js" as="script"><link rel="prefetch" href="/assets/plugin.html-B0f8ugSJ.js" as="script"><link rel="prefetch" href="/assets/resource.html-DNtU27zT.js" as="script"><link rel="prefetch" href="/assets/index.html-ZsGb6qdg.js" as="script"><link rel="prefetch" href="/assets/agreement.html-CIw11Fq5.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-e92Hyk8w.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-5AD6hO_D.js" as="script"><link rel="prefetch" href="/assets/index.html-CdzWxPC8.js" as="script"><link rel="prefetch" href="/assets/config.html-j9fQDAFw.js" as="script"><link rel="prefetch" href="/assets/exception.html-DMiqZkRy.js" as="script"><link rel="prefetch" href="/assets/log.html-COLdEd-G.js" as="script"><link rel="prefetch" href="/assets/mkdoc.html-D73tZG7j.js" as="script"><link rel="prefetch" href="/assets/utils.html-CwoOEmAb.js" as="script"><link rel="prefetch" href="/assets/index.html-D-6tgNGL.js" as="script"><link rel="prefetch" href="/assets/config.html-Cdhmq7sU.js" as="script"><link rel="prefetch" href="/assets/fandq.html-E6e6xtkn.js" as="script"><link rel="prefetch" href="/assets/install.html-D-ndbsdO.js" as="script"><link rel="prefetch" href="/assets/index.html-CkvFkhl8.js" as="script"><link rel="prefetch" href="/assets/dev_comm.html-DuAcfFFN.js" as="script"><link rel="prefetch" href="/assets/dev_lyfunc.html-4s3z9IWd.js" as="script"><link rel="prefetch" href="/assets/dev_lyplugin.html-CGX1C98c.js" as="script"><link rel="prefetch" href="/assets/dev_resource_pack.html-D5WRVsmT.js" as="script"><link rel="prefetch" href="/assets/index.html-BwLh6Ool.js" as="script"><link rel="prefetch" href="/assets/plugin.html-C8_d2nmp.js" as="script"><link rel="prefetch" href="/assets/resource.html-OwmP42ER.js" as="script"><link rel="prefetch" href="/assets/index.html-Cy8BrqNe.js" as="script"><link rel="prefetch" href="/assets/agreement.html-B0E_XwaP.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-DysXPAio.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-BehN1_ku.js" as="script"><link rel="prefetch" href="/assets/index.html-BzWubMak.js" as="script"><link rel="prefetch" href="/assets/lifespan.html-BG696ltt.js" as="script"><link rel="prefetch" href="/assets/index.html-Ccb3CTGg.js" as="script"><link rel="prefetch" href="/assets/channel.html-EZnVaz_O.js" as="script"><link rel="prefetch" href="/assets/event.html-C8DZx7V-.js" as="script"><link rel="prefetch" href="/assets/storage.html-BNPTbyAh.js" as="script"><link rel="prefetch" href="/assets/index.html-CneiKuCx.js" as="script"><link rel="prefetch" href="/assets/manager.html-BgMLtrSv.js" as="script"><link rel="prefetch" href="/assets/index.html-BobPLjT8.js" as="script"><link rel="prefetch" href="/assets/observer.html-Dlu4R7Wo.js" as="script"><link rel="prefetch" href="/assets/plugin.html-C2ME-xAg.js" as="script"><link rel="prefetch" href="/assets/index.html-BpuqDrqX.js" as="script"><link rel="prefetch" href="/assets/event.html-BupI8-8c.js" as="script"><link rel="prefetch" href="/assets/matcher.html-B4AIfAkg.js" as="script"><link rel="prefetch" href="/assets/on.html-BlPWfw8x.js" as="script"><link rel="prefetch" href="/assets/permission.html-BUQQQ2fv.js"
|
|||
|
|
</head>
|
|||
|
|
<body>
|
|||
|
|
<div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">Skip to main content</a><!--]--><div class="theme-container has-toc"><!--[--><header id="navbar" class="vp-navbar"><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><!----><!--]--><!--[--><a class="route-link vp-brand" href="/en/"><img class="vp-nav-logo" src="https://cdn.liteyuki.icu/static/img/liteyuki_icon_640.png" alt><!----><span class="vp-site-name hide-in-pad">LiteyukiBot</span></a><!--]--><!--[--><!----><!--]--></div><div class="vp-navbar-center"><!--[--><!----><!--]--><!--[--><nav class="vp-nav-links"><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/en/" aria-label="Home"><span class="font-icon icon fa-fw fa-sm fas fa-home" style=""></span>Home<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/en/deploy/" aria-label="Deploy"><!---->Deploy<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/en/usage/" aria-label="Usage"><!---->Usage<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/en/store/" aria-label="Extensions"><!---->Extensions<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link active" href="/en/dev/" aria-label="Contribute"><!---->Contribute<!----></a></div></nav><!--]--><!--[--><!----><!--]--></div><div class="vp-navbar-end"><!--[--><!----><!--]--><!--[--><div class="nav-item"><div class="dropdown-wrapper i18n-dropdown"><button type="button" class="dropdown-title" aria-label="Select language"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon i18n-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="i18n icon" style="width:1rem;height:1rem;vertical-align:middle;"><path d="M379.392 460.8 494.08 575.488l-42.496 102.4L307.2 532.48 138.24 701.44l-71.68-72.704L234.496 460.8l-45.056-45.056c-27.136-27.136-51.2-66.56-66.56-108.544h112.64c7.68 14.336 16.896 27.136 26.112 35.84l45.568 46.08 45.056-45.056C382.976 312.32 409.6 247.808 409.6 204.8H0V102.4h256V0h102.4v102.4h256v102.4H512c0 70.144-37.888 161.28-87.04 210.944L378.88 460.8zM576 870.4 512 1024H409.6l256-614.4H768l256 614.4H921.6l-64-153.6H576zM618.496 768h196.608L716.8 532.48 618.496 768z"></path></svg><!--]--><span class="arrow"></span><ul class="nav-dropdown"><li class="dropdown-item"><a class="route-link nav-link" href="/dev/api/comm/channel.html" aria-label="简体中文"><!---->简体中文<!----></a></li><li class="dropdown-item"><a class="route-link nav-link active" href="/en/dev/api/comm/channel.html" aria-label="English"><!---->English<!----></a></li></ul></button></div></div><div class="nav-item vp-repo"><a class="vp-repo-link" href="https://github.com/LiteyukiStudio/LiteyukiBot" target="_blank" rel="noopener noreferrer" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="icon github-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="github icon" style="width:1.25rem;height:1.25rem;vertical-align:middle;"><path d="M511.957 21.333C241.024 21.333 21.333 240.981 21.333 512c0 216.832 140.544 400.725 335.574 465.664 24.49 4.395 32.256-10.07 32.256-23.083 0-11.69.256-44.245 0-85.205-136.448 29.61-164.736-64.64-164.736-64.64-22.315-56.704-54.4-71.765-54.4-71.765-44.587-30.464 3.285-29.824 3.285-29.824 49.195 3.413 75.179 50.517 75.179 50.517 43.776 75.008 114.816 53.333 142.762 40.79 4.523-31.66 17.152-53.377 31.19-65.537-108.971-12.458-223.488-54.485-223.488-242.602 0-53.547 19.114-97.323 50.517-131.67-5.035-12.33-21.93-62.293 4.779-129.834 0 0 41.258-13.184 134.912 50.346a469.803 469.803 0 0 1 122.88-16.554c41.642.213 83.626 5.632 122.88 16.554 93.653-63.488 134.784-50.346 134.784-50.346 26.752 67.541 9.898 117.504 4.864 129.834 31.402 34.347 50.474 78.123 50.474 131.67 0 188.586-114.73 230.016-224.042 242.09 17.578 15.232 33.578 44.672 33.578 90.454v135.85c0 13.142 7.936 27.606 32.854 22.87C862.25 912.597 1002.66
|
|||
|
|
|
|||
|
|
channel: 通道实例
|
|||
|
|
</code></pre><h3 id="def-set-channels-channels-dict-str-channel-none" tabindex="-1"><a class="header-anchor" href="#def-set-channels-channels-dict-str-channel-none"><span><em><strong>def</strong></em> <code>set_channels(channels: dict[str, Channel]) -> None</code></span></a></h3><p>设置通道实例</p><p>Args:</p><pre><code>channels: 通道名称
|
|||
|
|
</code></pre><h3 id="def-get-channel-name-str-channel" tabindex="-1"><a class="header-anchor" href="#def-get-channel-name-str-channel"><span><em><strong>def</strong></em> <code>get_channel(name: str) -> Channel</code></span></a></h3><p>获取通道实例</p><p>Args:</p><pre><code>name: 通道名称
|
|||
|
|
</code></pre><p>Returns:</p><h3 id="def-get-channels-dict-str-channel" tabindex="-1"><a class="header-anchor" href="#def-get-channels-dict-str-channel"><span><em><strong>def</strong></em> <code>get_channels() -> dict[str, Channel]</code></span></a></h3><p>获取通道实例</p><p>Returns:</p><h3 id="def-on-set-channel-data-tuple-str-dict-str-any-none" tabindex="-1"><a class="header-anchor" href="#def-on-set-channel-data-tuple-str-dict-str-any-none"><span><em><strong>def</strong></em> <code>on_set_channel(data: tuple[str, dict[str, Any]]) -> None</code></span></a></h3><h3 id="def-on-get-channel-data-tuple-str-dict-str-any-none" tabindex="-1"><a class="header-anchor" href="#def-on-get-channel-data-tuple-str-dict-str-any-none"><span><em><strong>def</strong></em> <code>on_get_channel(data: tuple[str, dict[str, Any]]) -> None</code></span></a></h3><h3 id="def-on-get-channels-data-tuple-str-dict-str-any-none" tabindex="-1"><a class="header-anchor" href="#def-on-get-channels-data-tuple-str-dict-str-any-none"><span><em><strong>def</strong></em> <code>on_get_channels(data: tuple[str, dict[str, Any]]) -> None</code></span></a></h3><h3 id="def-decorator-func-callable-t-any-callable-t-any" tabindex="-1"><a class="header-anchor" href="#def-decorator-func-callable-t-any-callable-t-any"><span><em><strong>def</strong></em> <code>decorator(func: Callable[[T], Any]) -> Callable[[T], Any]</code></span></a></h3><h3 id="async-def-wrapper-data-t-any" tabindex="-1"><a class="header-anchor" href="#async-def-wrapper-data-t-any"><span><em><strong>async def</strong></em> <code>wrapper(data: T) -> Any</code></span></a></h3><h3 id="class-channel-generic-t" tabindex="-1"><a class="header-anchor" href="#class-channel-generic-t"><span><em><strong>class</strong></em> <code>Channel(Generic[T])</code></span></a></h3><p>通道类，可以在进程间和进程内通信，双向但同时只能有一个发送者和一个接收者</p><p>有两种接收工作方式，但是只能选择一种，主动接收和被动接收，主动接收使用 <code>receive</code> 方法，被动接收使用 <code>on_receive</code> 装饰器</p><h3 id="def-init-self-id-str-type-check-optional-bool-none" tabindex="-1"><a class="header-anchor" href="#def-init-self-id-str-type-check-optional-bool-none"><span> <em><strong>def</strong></em> <code>__init__(self, _id: str, type_check: Optional[bool]) -> None</code></span></a></h3><p> 初始化通道</p><p>Args:</p><pre><code>_id: 通道ID
|
|||
|
|
|
|||
|
|
type_check: 是否开启类型检查, 若为空，则传入泛型默认开启，否则默认关闭
|
|||
|
|
</code></pre><h3 id="def-send-self-data-t-none" tabindex="-1"><a class="header-anchor" href="#def-send-self-data-t-none"><span> <em><strong>def</strong></em> <code>send(self, data: T) -> None</code></span></a></h3><p> 发送数据</p><p>Args:</p><pre><code>data: 数据
|
|||
|
|
</code></pre><h3 id="def-receive-self-t" tabindex="-1"><a class="header-anchor" href="#def-receive-self-t"><span> <em><strong>def</strong></em> <code>receive(self) -> T</code></span></a></h3><p> 接收数据</p><p>Args:</p><h3 id="def-close-self-none" tabindex="-1"><a class="header-anchor" href="#def-close-self-none"><span> <em><strong>def</strong></em> <code>close(self) -> None</code></span></a></h3><p> 关闭通道</p><h3 id="def-on-receive-self-filter-func-optional-filter-func-callable-callable-t-any-callable-t-any" tabindex="-1"><a class="header-anchor" href="#def-on-receive-self-filter-func-optional-filter-func-callable-callable-t-any-callable-t-any"><span> <em><strong>def</strong></em> <code>on_receive(self, filter_func: Optional[FILTER_FUNC]) -> Callable[[Callable[[T], Any]], Callable[[T], Any]]</code></span></a></h3><p> 接收数据并执行函数</p><p>Args:</p><pre><code>filter_func: 过滤函数，为None则不过滤
|
|||
|
|
</code></pre><p>Returns:</p><pre><code>装饰器，装饰一个函数在接收到数据后执行
|
|||
|
|
</code></pre><h3 id="var-t-typevar-t" tabindex="-1"><a class="header-anchor" href="#var-t-typevar-t"><span><em><strong>var</strong></em> <code>T = TypeVar('T')</code></span></a></h3><h3 id="var-channel-deliver-active-channel-channel-id-channel-deliver-active-channel" tabindex="-1"><a class="header-anchor" href="#var-channel-deliver-active-channel-channel-id-channel-deliver-active-channel"><span><em><strong>var</strong></em> <code>channel_deliver_active_channel = Channel(_id='channel_deliver_active_channel')</code></span></a></h3><h3 id="var-channel-deliver-passive-channel-channel-id-channel-deliver-passive-channel" tabindex="-1"><a class="header-anchor" href="#var-channel-deliver-passive-channel-channel-id-channel-deliver-passive-channel"><span><em><strong>var</strong></em> <code>channel_deliver_passive_channel = Channel(_id='channel_deliver_passive_channel')</code></span></a></h3><h3 id="var-recv-chan-data-1-recv-chan" tabindex="-1"><a class="header-anchor" href="#var-recv-chan-data-1-recv-chan"><span><em><strong>var</strong></em> <code>recv_chan = data[1]['recv_chan']</code></span></a></h3><h3 id="var-recv-chan-channel-channel-any-recv-chan" tabindex="-1"><a class="header-anchor" href="#var-recv-chan-channel-channel-any-recv-chan"><span><em><strong>var</strong></em> <code>recv_chan = Channel[Channel[Any]]('recv_chan')</code></span></a></h3><h3 id="var-recv-chan-channel-dict-str-channel-any-recv-chan" tabindex="-1"><a class="header-anchor" href="#var-recv-chan-channel-dict-str-channel-any-recv-chan"><span><em><strong>var</strong></em> <code>recv_chan = Channel[dict[str, Channel[Any]]]('recv_chan')</code></span></a></h3><h3 id="var-type-check-self-get-generic-type-is-not-none" tabindex="-1"><a class="header-anchor" href="#var-type-check-self-get-generic-type-is-not-none"><span><em><strong>var</strong></em> <code>type_check = self._get_generic_type() is not None</code></span></a></h3><h3 id="var-data-self-conn-recv-recv" tabindex="-1"><a class="header-anchor" href="#var-data-self-conn-recv-recv"><span><em><strong>var</strong></em> <code>data = self.conn_recv.recv()</code></span></a></h3><h3 id="var-func-callback-funcs-func-id" tabindex="-1"><a class="header-anchor" href="#var-func-callback-funcs-func-id"><span><em><strong>var</strong></em> <code>func = _callback_funcs[func_id]</code></span></a></h3><h3 id="var-func-callback-funcs-func-id-1" tabindex="-1"><a class="header-anchor" href="#var-func-callback-funcs-func-id-1"><span><em><strong>var</strong></em> <code>func = _callback_funcs[func_id]</code></span></a></h3><h3 id="var-data-self-conn-recv-recv-1" tabindex="-1"><a class="header-anchor" href="#var-data-self-conn-recv-recv-1"><span><em><strong>var</strong></em> <code>data = self.conn_recv.recv()</code></span></a></h3><h3 id="var-data-self-conn-recv-recv-2" tabindex="-1"><a class="header-anchor" href="#var-data-self-conn-recv-recv-2"><span><em><strong>var</strong></em> <code>data = self.conn_recv.recv()</code></span></a></h3></div><!--[--><!----><!--]--><footer class="page-meta"><div class="meta-item edit-link"><a href="https://github.com/LiteyukiStudio/LiteyukiBot/edit/main/docs/en/dev/api/comm/channel.md" rel="noopener noreferrer" target="_blank" aria-label="在 GitHub 上编辑" class="nav-link label"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon edit-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="edit icon"><path d="M430.818 653.65a60.46 60.46 0 0 1-50.96-93.281l71.69-114.012 7.773-10.365L816.038 80.138A60.46 60.46 0 0 1 859.225 62a60.46 60.46 0 0 1 43.186 18.138l43.186 43.186a60.46 60.46 0 0 1 0 86.373L588.879 565.55l-8.637 8.637-117.466 68.234a60.46 60.46 0 0 1-31.958 11.229z"></path><path d="M728.802 962H252.891A190.883 190.883 0 0 1 62.008 771.98V296.934a190.883 190.883 0 0 1 190.883-192.61h267.754a60.46 60.46 0 0 1 0 120.92H252.891a69.962 69.962 0 0 0-69.098 69.099V771.98a69.962 69.962 0 0 0 69.098 69.098h475.911A69.962 69.962 0 0 0 797.9 771.98V503.363a60.46 60.46 0 1 1 120.922 0V771.98A190.883 190.883 0 0 1 728.802 962z"></path></s
|
|||
|
|
<script type="module" src="/assets/app-Dk7jq3Nw.js" defer></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|