XU XUv0.13.1
EN

#embedded/wifi/ipv4

导入方式: #embedded/wifi/ipv4

公开 API: 7 函数, 4 方法, 2 类型, 5 常量, 0 方法集

标准库包 `#embedded/wifi/ipv4`。

const DHCP_READY

XuAPI
pub const DHCP_READY = 0

用途

常量 DHCP_READY,定义了相关的协议或算法配置参数。

const DHCP_SELECTING

XuAPI
pub const DHCP_SELECTING = 1

用途

常量 DHCP_SELECTING,定义了相关的协议或算法配置参数。

const DHCP_REQUESTING

XuAPI
pub const DHCP_REQUESTING = 2

用途

常量 DHCP_REQUESTING,定义了相关的协议或算法配置参数。

const DHCP_LEASED

XuAPI
pub const DHCP_LEASED = 3

用途

常量 DHCP_LEASED,定义了相关的协议或算法配置参数。

const DHCP_FAILED

XuAPI
pub const DHCP_FAILED = 4

用途

常量 DHCP_FAILED,定义了相关的协议或算法配置参数。

struct Client

XuAPI
pub struct Client {
    pub state int
    pub mac string
    pub xid string
    pub offered string
    pub server string
    pub address string // empty until a matching, valid DHCPACK
    pub mask string
    pub router string
    pub lease_seconds string // network-order uint32; not a host-width int
}

用途

Ipv4 客户端会话实例,维护与服务端的连接并提供操作接口。

公开字段

state int
字段(int)
mac string
字段(string)
xid string
字段(string)
offered string
字段(string)
server string
字段(string)
address string // empty until a matching, valid DHCPACK
字段(string // empty until a matching, valid DHCPACK)
mask string
字段(string)
router string
字段(string)
lease_seconds string // network-order uint32; not a host-width int
字段(string // network-order uint32; not a host-width int)

create

XuAPI
pub fn create(mac string, xid string) Client

用途

创建新的文件、目录或资源。

参数

mac string
mac(string)
xid string
xid(string)

返回值

Client — 该类型的值

($&Client) discover

XuAPI
pub fn (c $&Client) discover() string

用途

在 $&Client 上执行 discover 操作。

参数

c $&Client
本次调用使用的 Client 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

string — 结果字符串

($&Client) request

XuAPI
pub fn (c $&Client) request() string

用途

$&Client 上的操作:请求。

参数

c $&Client
本次调用使用的 Client 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

string — 结果字符串

($&Client) receive_llc

XuAPI
pub fn (c $&Client) receive_llc(payload &string) bool

用途

$&Client 上的操作:执行 receive llc 操作。

参数

c $&Client
本次调用使用的 Client 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
payload &string
payload(只读借用,调用方仍持有原值;类型 &string)

返回值

bool — 是否成立

($&Client) receive_ethernet

XuAPI
pub fn (c $&Client) receive_ethernet(frame &string) bool

用途

$&Client 上的操作:执行 receive ethernet 操作。

参数

c $&Client
本次调用使用的 Client 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
frame &string
frame(只读借用,调用方仍持有原值;类型 &string)

返回值

bool — 是否成立

arp_request

XuAPI
pub fn arp_request(mac &string, source_ip &string, target_ip &string) string

用途

执行 arp request 操作。

参数

mac &string
mac(只读借用,调用方仍持有原值;类型 &string)
source_ip &string
source_ip(只读借用,调用方仍持有原值;类型 &string)
target_ip &string
target_ip(只读借用,调用方仍持有原值;类型 &string)

返回值

string — 结果字符串

arp_reply_mac

XuAPI
pub fn arp_reply_mac(payload &string, own_mac &string, own_ip &string, target_ip &string) string

用途

执行 arp reply mac 操作。

参数

payload &string
payload(只读借用,调用方仍持有原值;类型 &string)
own_mac &string
own_mac(只读借用,调用方仍持有原值;类型 &string)
own_ip &string
own_ip(只读借用,调用方仍持有原值;类型 &string)
target_ip &string
target_ip(只读借用,调用方仍持有原值;类型 &string)

返回值

string — 结果字符串

echo_request

XuAPI
pub fn echo_request(source_ip &string, target_ip &string, id int, sequence int, body &string) string

用途

执行 echo request 操作。

参数

source_ip &string
source_ip(只读借用,调用方仍持有原值;类型 &string)
target_ip &string
target_ip(只读借用,调用方仍持有原值;类型 &string)
id int
id(int)
sequence int
sequence(int)
body &string
正文(只读借用,调用方仍持有原值;类型 &string)

返回值

string — 结果字符串

echo_reply_valid

XuAPI
pub fn echo_reply_valid(payload &string, source_ip &string, target_ip &string, id int, sequence int, body &string) bool

用途

执行 echo reply valid 操作。

参数

payload &string
payload(只读借用,调用方仍持有原值;类型 &string)
source_ip &string
source_ip(只读借用,调用方仍持有原值;类型 &string)
target_ip &string
target_ip(只读借用,调用方仍持有原值;类型 &string)
id int
id(int)
sequence int
sequence(int)
body &string
正文(只读借用,调用方仍持有原值;类型 &string)

返回值

bool — 是否成立

struct ArpResponse

XuAPI
pub struct ArpResponse {
    pub valid bool
    pub destination string
    pub payload string
}

用途

Ipv4 服务端响应结果,包含状态码、响应头与正文数据。

公开字段

valid bool
字段(bool)
destination string
字段(string)
payload string
字段(string)

arp_response

XuAPI
pub fn arp_response(payload &string, own_mac &string, own_ip &string) ArpResponse

用途

执行 arp response 操作。

参数

payload &string
payload(只读借用,调用方仍持有原值;类型 &string)
own_mac &string
own_mac(只读借用,调用方仍持有原值;类型 &string)
own_ip &string
own_ip(只读借用,调用方仍持有原值;类型 &string)

返回值

ArpResponse — 该类型的值

echo_response

XuAPI
pub fn echo_response(payload &string, own_ip &string) string

用途

执行 echo response 操作。

参数

payload &string
payload(只读借用,调用方仍持有原值;类型 &string)
own_ip &string
own_ip(只读借用,调用方仍持有原值;类型 &string)

返回值

string — 结果字符串