network - 网络接口适配#

本页文档由这个文件自动生成。如有错误,请提交issue或帮忙修改后pr,谢谢!

network.create(adapter, cb)#

在某个适配的网卡上申请一个network_ctrl

参数

传入值类型

解释

int

适配器序号, 只能是network.ETH0,network.STA,network.AP,如果不填,会选择最后一个注册的适配器

string

or function string为消息通知的taskName,function则为回调函数,如果固件没有内置sys_wait,则必须是function

返回值

例子


network.debug(ctrl, onoff)#

配置是否打开debug信息

参数

传入值类型

解释

user_data

network.create得到的ctrl

boolean

true 打开debug开关

返回值

返回值类型

解释

nil

无返回值

例子


network.config(ctrl, local_port, is_udp, is_tls, keep_idle, keep_interval, keep_cnt, server_cert, client_cert, client_key, client_password)#

配置network一些信息,

参数

传入值类型

解释

user_data

network.create得到的ctrl

int

本地端口号,小端格式,如果不写,则自动分配一个,如果用户填了端口号则需要小于60000, 默认不写

boolean

是否是UDP,默认false

boolean

是否是加密传输,默认false

int

tcp keep live模式下的idle时间,如果留空则表示不启用,如果是不支持标准posix接口的网卡(比如W5500),则为心跳间隔

int

tcp keep live模式下的探测间隔时间

int

tcp keep live模式下的探测次数

string

TCP模式下的服务器ca证书数据,UDP模式下的PSK,不需要加密传输写nil,后续参数也全部nil

string

TCP模式下的客户端ca证书数据,UDP模式下的PSK-ID,TCP模式下如果不需要验证客户端证书时,忽略,一般不需要验证客户端证书

string

TCP模式下的客户端私钥加密数据

string

TCP模式下的客户端私钥口令数据

返回值

返回值类型

解释

nil

无返回值

例子

network.config(ctrl, nil, nil ,true)	--最普通的加密TCP传输,证书都不用验证的那种

network.linkup(ctrl)#

等待网卡linkup

参数

传入值类型

解释

user_data

network.create得到的ctrl

返回值

返回值类型

解释

boolean

true有异常发生,false没有异常,如果有error则不需要看下一个返回值了

boolean

true已经linkup,false没有linkup,之后需要接收network.LINK消息

例子


network.connect(ctrl, ip, remote_port)#

作为客户端连接服务器

参数

传入值类型

解释

user_data

network.create得到的ctrl

string

or int ip或者域名,如果是IPV4,可以是大端格式的int值

int

服务器端口号,小端格式

返回值

返回值类型

解释

boolean

true有异常发生,false没有异常,如果有error则不需要看下一个返回值了,如果有异常,后续要close

boolean

true已经connect,false没有connect,之后需要接收network.ON_LINE消息

例子


network.discon(ctrl)#

作为客户端断开连接

参数

传入值类型

解释

user_data

network.create得到的ctrl

返回值

例子


network.close(ctrl)#

强制关闭socket

参数

传入值类型

解释

user_data

network.create得到的ctrl

返回值

例子


network.tx(ctrl, data, ip, port, flag)#

发送数据给对端

参数

传入值类型

解释

user_data

network.create得到的ctrl

string

or user_data zbuff 要发送的数据

string

or int 对端IP,如果是TCP应用则忽略,如果是UDP,如果留空则用connect时候的参数,如果是IPV4,可以是大端格式的int值

int

对端端口号,小端格式,如果是TCP应用则忽略,如果是UDP,如果留空则用connect时候的参数

int

发送参数,目前预留,不起作用

返回值

返回值类型

解释

boolean

true有异常发生,false没有异常,如果有error则不需要看下一个返回值了,如果有异常,后续要close

boolean

true缓冲区满了,false没有异常,如果true,则需要等待一段时间或者等到network.TX_OK消息后再尝试发送,同时忽略下一个返回值

boolean

true已经收到应答,false没有收到应答,之后需要接收network.TX_OK消息, 也可以忽略继续发送,直到full==true

例子


network.rx(ctrl, buff, flag)#

接收对端发出的数据,注意数据已经缓存在底层,使用本函数只是提取出来,UDP模式下一次只会取出一个数据包

参数

传入值类型

解释

user_data

network.create得到的ctrl

user_data

zbuff 存放接收的数据,如果缓冲区不够大会自动扩容

int

接收参数,目前预留,不起作用

返回值

返回值类型

解释

boolean

true有异常发生,false没有异常,如果有异常,后续要close

int

本次接收到数据长度

string

对端IP,只有UDP模式下才有意义,TCP模式返回nil,注意返回的格式,如果是IPV4,1byte 0x00 + 4byte地址 如果是IPV6,1byte 0x01 + 16byte地址

int

对端port,只有UDP模式下才有意义,TCP模式返回0

例子


network.wait(ctrl)#

等待新的socket消息,在连接成功和发送数据成功后,使用一次将network状态转换到接收新数据

参数

传入值类型

解释

user_data

network.create得到的ctrl

返回值

返回值类型

解释

boolean

true有异常发生,false没有异常,如果有异常,后续要close

boolean

true有新的数据需要接收,false没有数据,之后需要接收network.EVENT消息

例子


network.listen(ctrl)#

作为服务端开始监听

参数

传入值类型

解释

user_data

network.create得到的ctrl

返回值

返回值类型

解释

boolean

true有异常发生,false没有异常,如果有error则不需要看下一个返回值了,如果有异常,后续要close

boolean

true已经connect,false没有connect,之后需要接收network.ON_LINE消息

例子


network.accept(ctrl)#

作为服务端接收到一个新的客户端,注意,如果是类似W5500的硬件协议栈不支持1对多,则不需要第二个参数

参数

传入值类型

解释

user_data

network.create得到的ctrl,这里是服务器端

string

or function or nil string为消息通知的taskName,function则为回调函数,和network.create参数一致

返回值

返回值类型

解释

boolean

true有异常发生,false没有异常,如果有error则不需要看下一个返回值了,如果有异常,后续要close

user_data

or nil 如果支持1对多,则会返回新的ctrl,自动create,如果不支持则返回nil

例子


network.release(ctrl)#

主动释放掉network_ctrl

参数

返回值

例子


network.setDNS(adapter_index, dns_index, ip)#

设置DNS服务器

参数

传入值类型

解释

int

适配器序号, 只能是network.ETH0,network.STA,network.AP,如果不填,会选择最后一个注册的适配器

int

dns服务器序号,从1开始

string

or int dns,如果是IPV4,可以是大端格式的int值

返回值

返回值类型

解释

boolean

成功返回true,失败返回false

例子