> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kasoftware.com/llms.txt
> Use this file to discover all available pages before exploring further.

# TCP Server 端口

> 托管通用 TCP/IP 端点，用于接收任意数据流，支持可配置的消息分隔、TLS/SSL 及双向通信。

export const TrustedIp = () => <>
    <p><strong>可信 IP 地址</strong> 部分提供以下功能：</p>

    <table>
      <thead>
        <tr><th>功能</th><th>描述</th></tr>
      </thead>
      <tbody>
        <tr><td><strong>添加</strong></td><td>输入新的 IP 地址范围。</td></tr>
        <tr><td><strong>编辑</strong></td><td>修改选定的 IP 地址范围。</td></tr>
        <tr><td><strong>删除</strong></td><td>从列表中删除选定的 IP 地址范围。</td></tr>
      </tbody>
    </table>

    <p>以下限制适用于此功能：</p>

    <ul style={{
  listStyleType: 'disc',
  paddingLeft: '1.5rem'
}}>
      <li style={{
  display: 'list-item'
}}><code>localhost</code> 不能被修改或从列表中删除。</li>
      <li style={{
  display: 'list-item'
}}>任何超出定义范围的 IP 地址都将被拒绝。</li>
      <li style={{
  display: 'list-item'
}}>支持 IP 范围。例如，条目 <code>100.10.100.1-15</code> 表示允许 <code>100.10.100.1</code> 和 <code>100.10.100.15</code> 之间的 IP 地址。</li>
      <li style={{
  display: 'list-item'
}}>支持无类别域间路由 (CIDR) 表示法。例如，条目 <code>100.10.100.0/24</code> 表示允许 <code>100.10.100.0</code> 和 <code>100.10.100.255</code> 之间的 IP 地址。</li>
      <li style={{
  display: 'list-item'
}}>支持通配符模式。例如，条目 <code>100.10.100.*</code> 表示允许以 <code>100.10.100</code> 开头的 IP 地址。</li>
    </ul>

    <Note>
      <p>为了让客户端能够访问服务器，需要有清晰的网络路径。在云环境中，可能需要在三个地方进行更改：</p>
      <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• 云控制台中的网络规则。</p>
      <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• 托管应用程序的机器上的防火墙规则。例如，在使用 Amazon AMI 时，可以使用 <em>简单防火墙</em>（UFW）来允许所需端口上的流量。Linux 环境中的常见策略是将流量从低于 1024 的端口转发到高于 1024 的非标准端口，同时将应用程序配置为使用非标准端口。这可以避免与非 root 用户绑定到低于 1024 的端口相关的权限问题。</p>
      <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <a href="/26.2/self-hosted/zh/getting-started/administration/settings/security">安全</a> 选项卡的 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/network-access">网络访问</a> 部分。</p>
    </Note>
  </>;

export const SlasTab = ({siteName = "知行之桥"}) => <>
    <p><em>与配置服务级别协议 (SLA) 相关的设置。</em></p>
    <p>
      SLA 允许配置预期流程中端口发送或接收的数据量，并设置预期达到该数据量的时间范围。当 SLA 未达到时，{siteName} 会发送电子邮件警告用户，并将 SLA 标记为 <em>存在风险</em>，这意味着如果 SLA 未能尽快达到，则会被标记为 <em>已违反</em>。这让用户有机会介入并确定 SLA 未达到的原因，并采取适当的措施。如果在风险时间段结束时仍未达到 SLA，则会将 SLA 标记为已违反，并再次通知用户。
    </p>
    <p>
      要定义 SLA，请启用 <strong>预期数据量</strong>，然后点击 <strong>设置</strong> 选项卡。
    </p>
    <img src="/public/images/sla_empty.png" alt="SLA Empty" />
    <ul>
      <li>如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 适用的方向。</li>
      <li>在窗口的 <strong>预计至少</strong> 部分中：
        <ul>
          <li>设置预计处理的最小事务数量（交易量）</li>
          <li>使用 <strong>每个</strong> 字段指定时间范围</li>
          <li>指示 SLA 生效的时间。如果选择 <strong>开始于</strong>，请填写日期和时间字段。</li>
          <li>勾选希望 SLA 生效的星期几对应的复选框。如有必要，请使用下拉菜单选择 <strong>每天</strong>。</li>
        </ul>
      </li>
      <li>在窗口的 <strong>将状态设置为“有风险”</strong> 部分中，指定应将 SLA 标记为有风险的时间。
        <ul>
          <li>默认情况下，只有在违反 SLA 的情况下才会发送通知。要更改此设置，请勾选 <strong>发送“有风险”通知</strong>。</li>
        </ul>
      </li>
    </ul>
    <p>
      以下示例显示了为端口配置的 SLA，该端口预计在周一至周五每天接收 1000 个文件。如果尚未收到 1000 个文件，则会在时间段结束前 1 小时发送风险通知。
    </p>
    <img src="/public/images/sla_defined.png" alt="SLA Configuration Example" />
    <Note>
      如果有必要，可以关闭 SLA 通知。这在维护窗口期间非常有用。点击导航栏上的 <strong>设置</strong>，然后跳转到 <strong>通知 &gt; 通用通知</strong>。点击平板和铅笔图标进行编辑，并取消勾选 <strong>SLA 通知</strong> 设置。
    </Note>
  </>;

export const AlertsTab = ({siteNameShort = "知行之桥"}) => <>
    <p><em>与配置通知相关的设置。</em></p>
    <p>
      在执行服务级别协议 (SLA) 之前，需要设置电子邮件通知以接收通知。默认情况下，{siteNameShort} 使用 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/alerts">通知</a> 选项卡上的全局设置。要为此端口使用其他设置，请启用 <strong>覆盖全局设置</strong>。
    </p>
    <p>
      默认情况下，错误通知处于启用状态，这意味着每当出现错误时都会发送电子邮件。要关闭错误通知，请取消选中 <strong>启用</strong> 复选框。
    </p>
    <p>
      输入 <strong>主题</strong>（必填），然后（可选）输入以逗号分隔的 <strong>收件人</strong> 电子邮件列表。
    </p>
  </>;

export const Message = () => <>
    <p><em>消息设置确定端口如何搜索消息并在处理后管理它们。</em></p>
    <table>
      <thead>
        <tr><th>设置</th><th>描述</th></tr>
      </thead>
      <tbody>
        
          <tr>
            <td><strong>保存到已发送文件夹</strong></td>
            <td>选中此项可将端口处理的文件复制到该端口的“已发送”文件夹中。</td>
          </tr>
        
        <tr>
          <td><strong>已发送文件夹方案</strong></td>
          <td>端口根据选定的时间间隔对 <strong>已发送</strong> 文件夹中的文件进行分组。例如，<strong>Weekly</strong> 选项指示端口每周创建一个新的子文件夹，并将本周发送的所有文件存储在该文件夹中。空白设置告诉端口将所有文件直接保存在 <strong>已发送</strong> 文件夹中。对于处理许多事务的端口，使用子文件夹可以帮助保持文件有序并提高性能。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MiscConnector = () => <>
    <p><em>特殊设置适用于特定用例。</em></p>
    <table>
      <thead>
        <tr>
          <th>设置</th>
          <th>描述</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>其他设置</strong></td>
          <td>允许在以分号分隔的列表中配置隐藏的端口设置，例如 <code>setting1=value1;setting2=value2</code>。正常的端口用例和功能不需要使用这些设置。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const Logging = () => <>
    <p><em>用于管理日志创建和存储的设置。</em></p>
    <table>
      <thead>
        <tr>
          <th>设置</th>
          <th>描述</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>日志级别</strong></td>
          <td>指定要记录在端口日志目录中的信息类型：
            <ul>
              <li><b>None</b> - 不创建任何日志。</li>
              <li><b>Error</b> - 仅当端口遇到错误时才创建日志。</li>
              <li><b>Warning</b> - 仅当端口发出警告时才创建日志。</li>
              <li><b>Info</b> - 记录工作流的一般信息，包括任何错误和警告（如果适用）。</li>
              <li><b>Debug</b> - 记录成功和失败工作流的详细调试信息。</li>
              <li><b>Trace</b> - 记录成功和失败工作流的详细跟踪信息。</li>
            </ul>
            <strong>请注意：</strong><strong>Debug</strong> 和 <strong>Trace</strong> 级别的日志可能会记录敏感信息，包括消息内容和 SSL 证书。尽管连接属性（例如密码）被屏蔽了，但在与您的组织外部共享它们之前，请查看此级别的日志以避免泄漏敏感信息。</td>
        </tr>
        <tr>
          <td><strong>日志文件夹结构</strong></td>
          <td>指示端口根据选定的时间间隔将日志文件夹中的文件分组。例如，<strong>Weekly</strong> 选项指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。空白设置告诉端口将所有日志直接保存在日志文件夹中。对于处理许多事务的端口，使用子文件夹有助于保持日志的有序性并提高性能。</td>
        </tr>
        <tr>
          <td><strong>保留消息副本</strong></td>
          <td>指示端口在日志目录中保存最新消息副本的切换。请注意，端口每个子文件夹只保留一个消息，并且端口在再次运行时会覆盖以前保存的消息。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MacrosExamples = ({extraMacros = []}) => <>
    <p>
      某些宏（例如 %Ext% 和 %ShortDate%）不需要参数，但其他宏则需要。所有带有参数的宏都使用以下语法：<code>%Macro:argument%</code>
    </p>

    <p>以下是带有参数的宏的一些示例：</p>

    <ul>
      <li>%Header:headername%：其中 <code>headername</code> 是消息上消息头的名称。</li>
      <li>%Header:mycustomheader% 解析为输入消息上设置的 <code>mycustomheader</code> 消息头的值。</li>
      <li>%Header:ponum% 解析为输入消息上设置的 <code>ponum</code> 消息头的值。</li>
      <li>%RegexFilename:pattern%：其中 <code>pattern</code> 是正则表达式模式。例如，<code>%RegexFilename:^([\w][A-Za-z]+)%</code> 匹配并解析为文件名中的第一个单词，并且不区分大小写（<code>test_file.xml</code> 解析为 <code>test</code>）。</li>
      <li>%Vault:vaultitem%：其中 <code>vaultitem</code> 是 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/global-settings-vault">vault</a> 中项目的名称。例如，<code>%Vault:companyname%</code> 解析为存储在保管库中的 <code>companyname</code> 项的值。</li>
      <li>%DateFormat:format%：其中 <code>format</code> 是可接受的日期格式（有关详细信息，请参阅 <a href="/26.2/self-hosted/zh/scripting/value-formatters/date-formatters#sample-date-formats">示例日期格式</a>）。例如，<code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code> 解析为文件上的日期和时间戳。</li>
      {extraMacros.filter(item => item.example).map(item => <li key={`ex-${item.name}`}>{item.example}</li>)}
    </ul>

    <p>还可以创建更复杂的宏，如以下示例所示：</p>

    <ul>
      <li>将多个宏组合在一个文件名中：<code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%</code></li>
      <li>包括宏之外的文本：<code>MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code></li>
      <li>在宏中包含文本：<code>%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%</code></li>
    </ul>
  </>;

export const MacrosTable = ({siteName = "知行之桥", extraMacros = []}) => <>
    <p>
      在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。通过将宏合并到文件名中，可以动态地包含相关信息，例如标识符、时间戳和消息头信息，从而为每个文件提供有价值的上下文。这有助于确保文件名反映对组织重要的详细信息。
    </p>

    <p>{siteName} 支持这些宏，它们都使用以下语法：<code>%Macro%</code>。</p>

    <table>
      <thead>
        <tr><th>宏</th><th>描述</th></tr>
      </thead>
      <tbody>
        <tr><td>ConnectorID</td><td>替换为端口的 ConnectorID。</td></tr>
        <tr><td>Ext</td><td>替换为端口当前正在处理的文件的文件扩展名。</td></tr>
        <tr><td>Filename</td><td>替换为端口当前正在处理的文件的文件名（包括扩展名）。</td></tr>
        <tr><td>FilenameNoExt</td><td>替换为端口当前正在处理的文件的文件名（不带扩展名）。</td></tr>
        <tr><td>MessageId</td><td>计算端口输出的消息的 MessageId。</td></tr>
        <tr><td>RegexFilename:<em>pattern</em></td><td>将正则表达式模式应用于端口当前正在处理的文件的文件名。</td></tr>
        <tr><td>Header:<em>headername</em></td><td>替换为端口正在处理的当前消息的目标消息头（<code>headername</code>）的值。</td></tr>
        <tr><td>LongDate</td><td>以常规格式计算系统的当前日期时间（例如，2024 年 1 月 24 日星期三）。</td></tr>
        <tr><td>ShortDate</td><td>以 yyyy-MM-dd 格式计算系统的当前日期时间（例如 2024-01-24）。</td></tr>
        <tr><td>DateFormat:<em>format</em></td><td>以指定格式（<code>format</code>）计算系统的当前日期时间。有关可用的日期时间格式，请参阅 <a href="/26.2/self-hosted/zh/scripting/value-formatters/date-formatters#date-formats-with-literal-characters">示例日期格式</a>。</td></tr>
        <tr><td>Vault:<em>vaultitem</em></td><td>计算指定保管库项目的值。</td></tr>
        {extraMacros.map(item => <tr key={item.name}>
            <td>{item.name}</td>
            <td>{item.description}</td>
          </tr>)}
      </tbody>
    </table>
  </>;

export const Performance = () => <>
    <p><em>与端口资源分配相关的设置。</em></p>
    <table>
      <thead>
        <tr>
          <th>设置</th>
          <th>描述</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>最大工作线程数</strong></td>
          <td>此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置，则会覆盖 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/advanced-settings">高级设置</a> 页面的 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/performance-settings">性能设置</a> 部分的默认设置。</td>
        </tr>
        <tr>
          <td><strong>最大文件数</strong></td>
          <td>分配给端口的每个线程发送的最大文件数。如果设置，则会覆盖 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/advanced-settings">高级设置</a> 页面的 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/performance-settings">性能设置</a> 部分的默认设置。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const siteNameShort = "知行之桥";

export const siteName = "知行之桥";

export const extraMacros = [{
  name: "ConnectionId",
  description: "替换为客户端用于上传数据的连接的 ConnectionId。"
}, {
  name: "RemoteHost",
  description: "替换为客户端用于上传数据的连接的 ConnectionId。"
}];

TCP Server 端口支持托管通用接口，通过 TCP 接收任意数据。

## 核心功能

* 通用 TCP/IP 服务器端点，支持 TLS/SSL 和明文传输，适用于任意数据流
* 可配置的消息分隔，支持使用静态分隔符或基于长度的解析
* 具备双向通信能力，支持基于连接 ID 的路由和连接事件消息

## 概述

每个 TCP Server 端口都会在指定的端口上监听传入的 TCP 流量，可以是 TLS/SSL 加密，也可以是纯文本。该端口适用于 {siteName} 需要接收不一定符合其它标准协议提供的约束的任意数据时的情况。

由于 TCP 流量是一个恒定的流，本质上没有"开始"或"结束"点，因此必须对端口进行配置，以确定一个消息的结束点和下一个消息的开始点。端口支持两种方法：

* 一个静态的字符串/字符分隔符，用于结束当前消息或开始下一个消息。
* 读取传入的 TCP 数据中的一个值，以确定信息的长度。

对于第二种方式，端口需要一个偏移量（从第一个字节后多少个字节开始读取消息长度）和一个大小（从偏移量开始读取长度值，要读取多少个字节）。如果消息的长度是消息的"头"中的第一个值，那么偏移量应该是 0。

一旦达到分隔符或长度，端口将向 {siteNameShort} 工作流推送包含通过 TCP 接收的原始数据的消息。

TCP Server 端口还可以在客户端连接或断开连接时生成 {siteNameShort} 消息，以提醒工作流中的其它进程。更多信息可参见[连接和断开消息](#连接和断开消息)部分。

有关向 TCP 客户端发送响应的信息，请参见[发送消息](#发送消息)部分。

## 端口配置

### 设置选项卡

#### 配置

*与端口关键配置有关的设置。*

| 设置        | 说明                          |
| --------- | --------------------------- |
| **端口 ID** | 端口的静态唯一标识符。                 |
| **端口类型**  | 显示端口名称及其功能描述。               |
| **端口描述**  | 可选字段，用于自由填写端口的描述及其在工作流中的作用。 |
| **端口**    | 监听传入 TCP 连接的端口。             |

#### 消息解码

*与区分 TCP 流中的单个消息有关的设置。*

| 设置          | 说明                               |
| ----------- | -------------------------------- |
| **消息起始分隔符** | 表示新消息开始的单个字符或十六进制值（以 `0x` 为前缀）。  |
| **消息结束分隔符** | 表示当前消息结束的单个字符或十六进制值（以 `0x` 为前缀）。 |
| **消息长度偏移**  | 从接收的数据中开始读取信息长度之前要跳过的字节数。        |
| **消息长度大小**  | 传入数据中长度值的大小（以字节为单位）。             |

#### TLS 设置

*与 TLS/SSL 传输安全相关的设置。*

| 设置         | 说明                                    |
| ---------- | ------------------------------------- |
| **启用 TLS** | 客户端是否必须协商 TLS/SSL 加密才能连接到 TCP Server。 |
| **服务器证书**  | 标识 TCP Server 的 TLS/SSL 证书。           |
| **证书密码**   | 访问服务器证书私钥的密码。                         |

### 高级设置选项卡

#### 保持活动

*与服务器发送 keep-alive 数据包以保持空闲连接有关的设置。*

| 设置                | 说明                                      |
| ----------------- | --------------------------------------- |
| **保持活动**          | 是否定期发送 keep-alive 数据包，以确保空闲连接不会因不活跃而关闭。 |
| **Keep Alive 时间** | 在发送第一个 keep-alive 数据包之前的空闲时间长度。         |
| **Keep Alive 间隔** | 连续的 keep-alive 数据包之间的间隔。                |

#### 高级设置

*先前目录中未包含的设置。*

| 设置            | 说明                                                                                                                        |
| ------------- | ------------------------------------------------------------------------------------------------------------------------- |
| **连接消息**      | 端口是否应该在客户端连接时生成 {siteNameShort} 消息。详见[连接和断开消息](#连接和断开消息)部分。                                                               |
| **断开消息**      | 端口是否应该在客户端断开连接时生成 {siteNameShort} 消息。详见[连接和断开消息](#连接和断开消息)部分。                                                             |
| **空闲时间**      | 服务器在因空闲而断开连接之前，等待空闲客户端的时间长度（秒）。                                                                                           |
| **本地文件命名方案**  | 为端口输出的消息分配文件名的方案。您可以在文件名中动态使用宏，以包含标识符和时间戳等信息。详见[宏](#宏)。                                                                   |
| **本机主机**      | 本地服务器的绑定地址（如果不是默认网络接口）。                                                                                                   |
| **最大连接**      | 并发端口的最大数量。                                                                                                                |
| **TLS 启用的协议** | 建立传出连接时支持的 TLS/SSL 协议列表。最佳实践是仅使用 TLS 协议。SSL v2 和 SSL v3 被认为存在漏洞，仅在您的合作伙伴不支持更高版本时使用。请注意，TLS v1.3 未被广泛采用，如果目标服务器不支持，可能会被拒绝。 |

#### 消息

<Message />

#### 日志

<Logging />

#### 杂项设置

<MiscConnector />

### 服务器选项卡

#### 受信任的 IP 地址

<TrustedIp />

### 自动化选项卡

#### 自动化

*与端口自动处理文件相关的设置。*

| 设置     | 说明             |
| ------ | -------------- |
| **发送** | 到达端口的消息是否自动处理。 |

#### 性能

<Performance />

### 告警选项卡

<AlertsTab />

### SLA 选项卡

<SlasTab />

## 连接和断开消息

默认情况下，TCP Server 端口仅在客户端传输数据时生成 {siteNameShort} 消息，以便端口识别完整的消息（根据[消息解码](#消息解码)部分的设置）。当客户端连接到服务器（如果在[高级设置选项卡](#高级设置选项卡)中启用了**连接消息**）或断开与服务器的连接（如果在高级设置选项卡中启用了**断开消息**）时，端口也可以生成 {siteNameShort} 消息。

当这些特殊消息生成后，{siteNameShort} 消息中会添加一个特殊的头部：

`x-tcpserver-event`

客户端连接时，此头部设置为值 `connected`，而客户端断开连接时，此头部设置为 `disconnected`。

该头部必须由工作流中之后的端口检查，以检测写入 TCP Server 端口输出文件夹的消息是否属于这些特殊消息。

## 发送消息

TCP Server 端口还使用一个特殊的头部值来向连接的客户端发送消息：

`x-tcpserver-connectionid`

该头部被添加到端口生成的任何输出消息中，设置为 "Connection ID" 值，以唯一标识所连接的客户端之一。为了确保消息被发送到正确的客户端，被发送回此客户端的消息 *必须* 将此相同的头部设置为相同的值。

由于该头部已经存在于端口写出的任何消息中，因此如果消息通过 {siteNameShort} 工作流并返回 TCP Server 端口的**交易**选项卡，它仍将具有相同的 "Connection ID" 值，并将返回给发送原始消息的同一个客户端。如果消息不能直接路由回 TCP Server 端口，那么必须保存 "Connection ID" 值，并将其作为一个头部（与上面列出的名称相同）应用到任何返回给客户端的新消息中。

## 宏

<MacrosTable extraMacros={extraMacros} />

### 示例

<MacrosExamples extraMacros={extraMacros} />