tcprelay 项目使用教程

tcprelay 项目使用教程

1. 项目目录结构及介绍

tcprelay/
├── README.md
├── LICENSE
├── Makefile
├── main.go
├── client/
│   └── client.go
├── server/
│   └── server.go
├── relay/
│   ├── relay.go
│   └── message.go
└── config/
    └── config.json

目录结构说明

• README.md: 项目介绍和使用说明。
• LICENSE: 项目许可证文件。
• Makefile: 用于构建和运行项目的Makefile文件。
• main.go: 项目的启动文件。
• client/: 包含客户端相关的代码文件。
• server/: 包含服务器相关的代码文件。
• relay/: 包含中继服务相关的代码文件。
• config/: 包含项目的配置文件。

2. 项目启动文件介绍

main.go

main.go 是项目的启动文件，负责初始化配置、启动中继服务、客户端和服务器。以下是 main.go 的主要功能：

package main

import (
    "tcprelay/relay"
    "tcprelay/client"
    "tcprelay/server"
    "tcprelay/config"
)

func main() {
    // 加载配置文件
    cfg := config.LoadConfig("config/config.json")

    // 启动中继服务
    relay.StartRelay(cfg)

    // 启动客户端
    client.StartClient(cfg)

    // 启动服务器
    server.StartServer(cfg)
}

功能说明

• 加载配置文件: 通过 config.LoadConfig 函数加载配置文件 config/config.json。
• 启动中继服务: 调用 relay.StartRelay 函数启动中继服务。
• 启动客户端: 调用 client.StartClient 函数启动客户端。
• 启动服务器: 调用 server.StartServer 函数启动服务器。

3. 项目配置文件介绍

config/config.json

config/config.json 是项目的配置文件，包含了中继服务、客户端和服务器的配置信息。以下是一个示例配置文件：

{
    "relay": {
        "address": "localhost",
        "port": 8000
    },
    "client": {
        "address": "localhost",
        "port": 8001
    },
    "server": {
        "address": "localhost",
        "port": 8002
    }
}

配置项说明

• relay: 中继服务的配置。
  • address: 中继服务的监听地址。
  • port: 中继服务的监听端口。
• client: 客户端的配置。
  • address: 客户端的监听地址。
  • port: 客户端的监听端口。
• server: 服务器的配置。
  • address: 服务器的监听地址。
  • port: 服务器的监听端口。

通过修改 config.json 文件，可以调整中继服务、客户端和服务器的运行参数。