TCP.js 项目教程

TCP.js 项目教程

tcp.jsA NodeJS library which proxies TCP connections, used by vnc.js项目地址:https://gitcode.com/gh_mirrors/tc/tcp.js

1. 项目的目录结构及介绍

tcp.js/
├── src/
│   ├── client.js
│   ├── server.js
│   └── utils.js
├── config/
│   └── default.json
├── test/
│   ├── client.test.js
│   └── server.test.js
├── package.json
├── README.md
└── .gitignore

• src/: 包含项目的源代码文件。
  • client.js: TCP 客户端实现。
  • server.js: TCP 服务器实现。
  • utils.js: 工具函数库。
• config/: 配置文件目录。
  • default.json: 默认配置文件。
• test/: 测试文件目录。
  • client.test.js: 客户端测试文件。
  • server.test.js: 服务器测试文件。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。
• .gitignore: Git 忽略文件配置。

2. 项目的启动文件介绍

项目的启动文件主要位于 src/ 目录下：

• server.js: 这是服务器的启动文件。它负责创建和启动 TCP 服务器，监听指定的端口并处理客户端连接。

const net = require('net');
const config = require('../config/default.json');

const server = net.createServer((socket) => {
  socket.on('data', (data) => {
    console.log('Received data:', data.toString());
    socket.write('Echo: ' + data);
  });

  socket.on('end', () => {
    console.log('Client disconnected');
  });
});

server.listen(config.port, () => {
  console.log(`Server listening on port ${config.port}`);
});

• client.js: 这是客户端的启动文件。它负责创建 TCP 客户端，连接到服务器并发送数据。

const net = require('net');
const config = require('../config/default.json');

const client = new net.Socket();

client.connect(config.port, config.host, () => {
  console.log('Connected to server');
  client.write('Hello from client');
});

client.on('data', (data) => {
  console.log('Received data:', data.toString());
  client.destroy(); // 关闭连接
});

client.on('close', () => {
  console.log('Connection closed');
});

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下：

• default.json: 包含项目的默认配置，如服务器监听的端口和主机地址。

{
  "port": 12345,
  "host": "127.0.0.1"
}

这个配置文件定义了服务器监听的端口和主机地址，可以在启动服务器和客户端时使用这些配置。

---

以上是 TCP.js 项目的教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用该项目。

tcp.jsA NodeJS library which proxies TCP connections, used by vnc.js项目地址:https://gitcode.com/gh_mirrors/tc/tcp.js