Skip to content

Commit c469bf4

Browse files
committed
📝 docs: README files
1 parent a75a9ba commit c469bf4

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# rdmahandler
2+
3+
`rdmahandler` 是一个 Go 语言包,专门用于实现 RDMA(Remote Direct Memory Access)通信。此包提供了一系列工具和接口,使用户能够方便地初始化服务器或客户端,进行数据读写,以及管理和销毁 RDMA 相关资源。
4+
5+
## 功能
6+
7+
- **初始化 RDMA 服务器和客户端**:通过 `InitServer``InitClient` 方法,用户可以轻松地设立 RDMA 服务器或作为客户端连接到 RDMA 服务器。
8+
- **数据读写**`Write``Read` 方法允许在 RDMA 连接上进行高效的数据传输。
9+
- **资源管理**`Destroy` 方法用于正确释放 RDMA 连接所使用的资源,确保资源的妥善管理。
10+
11+
## 接口和类型
12+
13+
- `RDMACommunicator`:此接口定义了用于 RDMA 通信的基本方法集。
14+
- `RDMAHandler`:实现了 `RDMACommunicator` 接口,提供具体的 RDMA 通信功能。
15+
- `RDMAResources`:封装了建立和管理 RDMA 连接所需的资源。
16+
17+
## 示例使用
18+
19+
```go
20+
handler := rdmahandler.RDMAHandler{}
21+
res, err := handler.InitServer(8080)
22+
if err != nil {
23+
log.Fatalf("Server initialization failed: %v", err)
24+
}
25+
// 使用 handler 执行 RDMA 操作
26+
...
27+
28+
```
29+
30+
## 安装
31+
32+
使用 `go get` 命令来安装 rdmahandler:
33+
34+
```bash
35+
go get github.com/breayhing/rdmahandler
36+
```

0 commit comments

Comments
 (0)