对象 Socket

网络套接口对象

Socket 属于 net 模块，创建方法

1
var s = new net.Socket();

继承关系

构造函数

Socket

Socket 构造函数，创建一个新的 Socket 对象

1
new Socket(Integer family = net.AF_INET);

调用参数:

• family: Integer, 指定地址集，缺省为 AF_INET，ipv4

成员属性

family

Integer, 查询当前 Socket 对象的地址集

1
readonly Integer Socket.family;

---

remoteAddress

String, 查询当前连接的对方地址

1
readonly String Socket.remoteAddress;

---

remotePort

Integer, 查询当前连接的对方端口

1
readonly Integer Socket.remotePort;

---

localAddress

String, 查询当前连接的本地地址

1
readonly String Socket.localAddress;

---

localPort

Integer, 查询当前连接的本地端口

1
readonly Integer Socket.localPort;

---

timeout

Integer, 查询和设置超时时间 单位毫秒

1
Integer Socket.timeout;

---

fd

Integer, 查询 Stream 对应的文件描述符值, 由子类实现

1
readonly Integer Socket.fd;

成员函数

connect

建立一个 tcp 连接

1
2
3
Socket.connect(String host,
    Integer port,
    Integer timeout = 0) async;

调用参数:

• host: String, 指定对方地址或主机名，也可以指向 unix socket 和 Windows pipe 路径
• port: Integer, 指定对方端口，连接 unix socket 和 Windows pipe 时，此参数需要为 0
• timeout: Integer, 指定超时时间，单位是毫秒，默认为 0

---

bind

将当前 Socket 绑定至本地所有地址的指定端口

1
2
Socket.bind(Integer port,
    Boolean allowIPv4 = true);

调用参数:

• port: Integer, 指定绑定的端口
• allowIPv4: Boolean, 指定是否接受 ipv4 连接，缺省为 true。本参数在 ipv6 时有效，并依赖于操作系统

---

将当前 Socket 绑定至指定地址的指定端口

1
2
3
Socket.bind(String addr,
    Integer port = 0,
    Boolean allowIPv4 = true);

调用参数:

• addr: String, 指定绑定的地址，也可以指向 unix socket 和 Windows pipe 路径
• port: Integer, 指定绑定的端口，绑定 unix socket 和 Windows pipe 时，忽略此参数
• allowIPv4: Boolean, 指定是否接受 ipv4 连接，缺省为 true。本参数在 ipv6 时有效，并依赖于操作系统

---

listen

开始监听连接请求

1
Socket.listen(Integer backlog = 120);

调用参数:

• backlog: Integer, 指定请求队列长度，超出的请求将被拒绝，缺省为 120

---

accept

等待并接受一个连接

1
Socket Socket.accept() async;

返回结果:

• Socket, 返回接收到得连接对象

---

recv

从连接读取指定大小的数据，不同于 read 方法，recv 并不保证读完要求的数据，而是在读取到数据后立即返回

1
Buffer Socket.recv(Integer bytes = -1) async;

调用参数:

• bytes: Integer, 指定要读取的数据量，缺省读取任意尺寸的数据

返回结果:

• Buffer, 返回从连接读取的数据

---

send

将给定的数据写入连接，此方法等效于 write 方法

1
Socket.send(Buffer data) async;

调用参数:

• data: Buffer, 给定要写入的数据

---

read

从流内读取指定大小的数据

1
Buffer Socket.read(Integer bytes = -1) async;

调用参数:

• bytes: Integer, 指定要读取的数据量，缺省为读取随机大小的数据块，读出的数据尺寸取决于设备

返回结果:

• Buffer, 返回从流内读取的数据，若无数据可读，或者连接中断，则返回 null

---

write

将给定的数据写入流

1
Socket.write(Buffer data) async;

调用参数:

• data: Buffer, 给定要写入的数据

---

flush

将文件缓冲区内容写入物理设备

1
Socket.flush() async;

---

close

关闭当前流对象

1
Socket.close() async;

---

copyTo

复制流数据到目标流中

1
2
Long Socket.copyTo(Stream stm,
    Long bytes = -1) async;

调用参数:

• stm: Stream, 目标流对象
• bytes: Long, 复制的字节数

返回结果:

• Long, 返回复制的字节数

---

toString

返回对象的字符串表示，一般返回 "[Native Object]"，对象可以根据自己的特性重新实现

1
String Socket.toString();

返回结果:

• String, 返回对象的字符串表示

---

toJSON

返回对象的 JSON 格式表示，一般返回对象定义的可读属性集合

1
Value Socket.toJSON(String key = "");

调用参数:

• key: String, 未使用

返回结果:

• Value, 返回包含可 JSON 序列化的值