#github.com/xulang-org/packages/mqtt

open

pub fn open(addr string, client_id string) Client

用途

打开。失败时 throw。

参数

addr string

地址（string）

client_id string

client_id（string）

返回

Client — 该类型的值

open_pool

pub fn open_pool(addr string, id_prefix string, max_idle int) Pool

用途

打开pool。

参数

addr string

地址（string）

id_prefix string

id_prefix（string）

max_idle int

max_idle（int）

返回

Pool — 该类型的值

struct Client

pub struct Client {
    pub fd int
    pub addr string
    pub client_id string
    pub next_pid int
}

用途

公开结构体 `Client`。

参数

fd int

文件描述符

addr string

地址

client_id string

字段（string）

next_pid int

字段（int）

struct Message

pub struct Message {
    pub topic string
    pub payload string
    pub qos int
}

用途

公开结构体 `Message`。

参数

topic string

字段（string）

payload string

字段（string）

qos int

字段（int）

connect_opts

pub fn connect_opts(addr string, client_id string, username string, password string, clean_session bool, keepalive int) Client

用途

connectopts。失败时 throw。

参数

addr string

地址（string）

client_id string

client_id（string）

username string

username（string）

password string

password（string）

clean_session bool

clean_session（bool）

keepalive int

keepalive（int）

返回

Client — 该类型的值

connect

pub fn connect(addr string, client_id string) Client

用途

connect，返回 Client。失败时 throw。

参数

addr string

地址（string）

client_id string

client_id（string）

返回

Client — 该类型的值

connect_auth

pub fn connect_auth(addr string, client_id string, username string, password string) Client

用途

connectauth。失败时 throw。

参数

addr string

地址（string）

client_id string

client_id（string）

username string

username（string）

password string

password（string）

返回

Client — 该类型的值

(&mut Client) ping

pub fn (c &mut Client) ping() bool

用途

在 `&mut Client` 上调用 `ping`。

参数

c &mut Client

接收者 &mut Client（可变借用）

返回

bool — 是否成立

(&mut Client) publish

pub fn (c &mut Client) publish(topic string, payload string, qos int) int

用途

在 `&mut Client` 上调用 `publish`。失败时 throw。

参数

c &mut Client

接收者 &mut Client（可变借用）

topic string

topic（string）

payload string

payload（string）

qos int

qos（int）

返回

int — 该类型的值

(&mut Client) subscribe

pub fn (c &mut Client) subscribe(topic string, qos int) int

用途

在 `&mut Client` 上调用 `subscribe`。失败时 throw。

参数

c &mut Client

接收者 &mut Client（可变借用）

topic string

topic（string）

qos int

qos（int）

返回

int — 该类型的值

(&mut Client) read_message

pub fn (c &mut Client) read_message() Message

用途

`&mut Client` 上的方法：读取message。失败时 throw。

参数

c &mut Client

接收者 &mut Client（可变借用）

返回

Message — 该类型的值

(&mut Client) disconnect

pub fn (c &mut Client) disconnect() int

用途

在 `&mut Client` 上调用 `disconnect`。

参数

c &mut Client

接收者 &mut Client（可变借用）

返回

int — 该类型的值

(&mut Client) close

pub fn (c &mut Client) close() int

用途

`&mut Client` 上的方法：关闭资源。

参数

c &mut Client

接收者 &mut Client（可变借用）

返回

int — 该类型的值

struct Pool

pub struct Pool {
    pub addr string
    pub id_prefix string
    pub idle chan int
    pub max_idle int
    pub seq chan int
}

用途

公开结构体 `Pool`。

参数

addr string

地址

id_prefix string

字段（string）

idle chan int

字段（通道；类型 chan int）

max_idle int

字段（int）

seq chan int

字段（通道；类型 chan int）

new_pool

pub fn new_pool(addr string, id_prefix string, max_idle int) Pool

用途

构造 pool。

参数

addr string

地址（string）

id_prefix string

id_prefix（string）

max_idle int

max_idle（int）

返回

Pool — 该类型的值

(&Pool) get

pub fn (p &Pool) get() Client

用途

在 `&Pool` 上调用 `get`。失败时 throw。

参数

p &Pool

接收者 &Pool（借用）

返回

Client — 该类型的值

(&Pool) put_conn

pub fn (p &Pool) put_conn(fd int)

用途

`&Pool` 上的方法：put连接。

参数

p &Pool

接收者 &Pool（借用）

fd int

文件描述符（int）

(&Pool) put

pub fn (p &Pool) put(c Client)

用途

在 `&Pool` 上调用 `put`。

参数

p &Pool

接收者 &Pool（借用）

c Client

字节或字符码（Client）

(&Pool) publish

pub fn (p &Pool) publish(topic string, payload string, qos int) int

用途

在 `&Pool` 上调用 `publish`。失败时 throw。

参数

p &Pool

接收者 &Pool（借用）

topic string

topic（string）

payload string

payload（string）

qos int

qos（int）

返回

int — 该类型的值

(&Pool) close

pub fn (p &Pool) close()

用途

`&Pool` 上的方法：关闭资源。

参数

p &Pool

接收者 &Pool（借用）

encode_u16

pub fn encode_u16(n int) string

用途

编码。

参数

n int

数量、长度或上限（int）

返回

string — 结果字符串

decode_u16

pub fn decode_u16(s &string, off int) int

用途

解码。

参数

s &string

源字符串（借用，调用方仍持有；类型 &string）

off int

偏移（int）

返回

int — 该类型的值

encode_str

pub fn encode_str(text string) string

用途

编码。

参数

text string

文本（string）

返回

string — 结果字符串

encode_var_len

pub fn encode_var_len(val int) string

用途

编码。

参数

val int

值（int）

返回

string — 结果字符串