Initial Dever 0.0.1

lib/doc/dever-net-socket.md

@@ -0,0 +1,76 @@
+# TCP 连接
+
+连接副本共用读写和关闭状态，网络等待使用异步运行时。
+
+## dever.net.ConnectResult
+
+TCP 连接结果，成功包含 socket。
+
+分支：
+- `Connected(socket: dever.system.Socket)`：连接成功
+- `error Failed(message: Text)`：连接失败
+
+## dever.net.ReadStreamResult
+
+TCP 读取流的创建结果。
+
+分支：
+- `Streaming(stream: AsyncStream<dever.io.ReadEvent>)`：读取流
+- `error Failed(message: Text)`：创建失败
+
+## dever.net.SystemReadResult
+
+底层 TCP 读取结果，在库内转换为 ReadState。
+
+分支：
+- `Read(bytes: Bytes)`：读取数据
+- `End`：数据结束
+- `error Failed(message: Text)`：读取失败
+
+## dever.net.connect
+
+连接给定主机和端口，支持 IP 地址或主机名。
+
+## dever.net.connectTimeout
+
+在指定毫秒期限内连接 IP 地址和端口；此入口不解析主机名。
+
+## dever.net.connected
+
+取出 socket；连接失败时继续传播错误。
+
+## dever.net.read
+
+读取最多 limit 字节，连接结束时返回 End。
+
+## dever.net.readState
+
+转换 TCP 读取状态；失败时传播 dever.io.ReadResult.Failed。
+
+## dever.net.write
+
+向 TCP 连接写入全部字节。
+
+## dever.net.timeout
+
+设置后续 TCP 读写的毫秒期限。
+
+## dever.net.wrote
+
+写入成功时继续执行，失败时传播错误。
+
+## dever.net.close
+
+关闭 TCP 连接及其共享别名。
+
+## dever.net.closed
+
+关闭成功时继续执行，失败时传播错误。
+
+## dever.net.chunks
+
+按需读取 TCP 数据块，返回异步字节事件流。
+
+## dever.net.readStream
+
+取出读取流；创建失败时继续传播错误。