API

`#github.com/xulang-org/packages/nats`

import: nats #github.com/xulang-org/packages/nats

counts: 8 函数, 17 方法, 4 类型, 0 常量, 0 方法集

扩展包 `nats #github.com/xulang-org/packages/nats`，由模块 github.com/xulang-org/packages 提供。

github.com/xulang-org/packages · 0.1.1 · 安装与使用

`open`

XuAPI

pub fn open(addr string) Client

用途

打开。失败时 throw。

参数

addr string: 地址（string）

Client — 该类型的值

`open_pool`

XuAPI

pub fn open_pool(addr string, max_idle int) Pool

用途

打开pool。

参数

addr string: 地址（string）
max_idle int: max_idle（int）

Pool — 该类型的值

`struct Client`

XuAPI

pub struct Client {
    pub fd int
    pub buf string
    pub addr string
    pub next_sid int
    pub server_info string
}

用途

公开结构体 `Client`。

参数

fd int: 文件描述符
buf string: 缓冲
addr string: 地址
next_sid int: 字段（int）
server_info string: 字段（string）

`(&mut Client) read_line`

XuAPI

pub fn (c &mut Client) read_line() string

用途

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

参数

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

string — 结果字符串

`(&mut Client) read_bytes`

XuAPI

pub fn (c &mut Client) read_bytes(n int) string

用途

`&mut Client` 上的方法：读到 delim（含 delim）。失败时 throw。

参数

c &mut Client: 接收者 &mut Client（可变借用）
n int: 数量、长度或上限（int）

string — 结果字符串

`(&mut Client) write_raw`

XuAPI

pub fn (c &mut Client) write_raw(data string) int

用途

`&mut Client` 上的方法：写入raw。失败时 throw。

参数

c &mut Client: 接收者 &mut Client（可变借用）
data string: 数据（string）

int — 该类型的值

`connect`

XuAPI

pub fn connect(addr string) Client

用途

connect，返回 Client。

参数

addr string: 地址（string）

Client — 该类型的值

`connect_auth`

XuAPI

pub fn connect_auth(addr string, user string, pass string) Client

用途

connectauth。失败时 throw。

参数

addr string: 地址（string）
user string: user（string）
pass string: pass（string）

Client — 该类型的值

`(&mut Client) ping`

XuAPI

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

用途

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

参数

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

bool — 是否成立

`(&mut Client) publish`

XuAPI

pub fn (c &mut Client) publish(subject string, data string) int

用途

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

参数

c &mut Client: 接收者 &mut Client（可变借用）
subject string: subject（string）
data string: 数据（string）

int — 该类型的值

`(&mut Client) publish_request`

XuAPI

pub fn (c &mut Client) publish_request(subject string, reply_to string, data string) int

用途

`&mut Client` 上的方法：publish请求。失败时 throw。

参数

c &mut Client: 接收者 &mut Client（可变借用）
subject string: subject（string）
reply_to string: reply_to（string）
data string: 数据（string）

int — 该类型的值

`(&mut Client) subscribe`

XuAPI

pub fn (c &mut Client) subscribe(subject string) Subscription

用途

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

参数

c &mut Client: 接收者 &mut Client（可变借用）
subject string: subject（string）

Subscription — 该类型的值

`(&mut Client) queue_subscribe`

XuAPI

pub fn (c &mut Client) queue_subscribe(subject string, queue_group string) Subscription

用途

`&mut Client` 上的方法：queuesubscribe。失败时 throw。

参数

c &mut Client: 接收者 &mut Client（可变借用）
subject string: subject（string）
queue_group string: queue_group（string）

Subscription — 该类型的值

`(&mut Client) unsubscribe`

XuAPI

pub fn (c &mut Client) unsubscribe(sub Subscription) int

用途

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

参数

c &mut Client: 接收者 &mut Client（可变借用）
sub Subscription: 子串（Subscription）

int — 该类型的值

`(&mut Client) next_msg`

XuAPI

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

用途

`&mut Client` 上的方法：下一项msg。失败时 throw。

参数

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

Message — 该类型的值

`(&mut Client) request`

XuAPI

pub fn (c &mut Client) request(subject string, data string) Message

用途

`&mut Client` 上的方法：请求。失败时 throw。

参数

c &mut Client: 接收者 &mut Client（可变借用）
subject string: subject（string）
data string: 数据（string）

Message — 该类型的值

`(&mut Client) close`

XuAPI

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

用途

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

参数

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

int — 该类型的值

`struct Message`

XuAPI

pub struct Message {
    pub subject string
    pub sid string
    pub reply_to string
    pub data string
}

用途

公开结构体 `Message`。

参数

subject string: 字段（string）
sid string: 字段（string）
reply_to string: 字段（string）
data string: 数据

`new_msg`

XuAPI

pub fn new_msg(subject string, sid string, reply_to string, data string) Message

用途

构造 msg。

参数

subject string: subject（string）
sid string: sid（string）
reply_to string: reply_to（string）
data string: 数据（string）

Message — 该类型的值

`struct Pool`

XuAPI

pub struct Pool {
    pub url string
    pub auth_user string
    pub auth_pass string
    pub idle chan int
    pub max_idle int
}

用途

公开结构体 `Pool`。

参数

url string: 字段（string）
auth_user string: 字段（string）
auth_pass string: 字段（string）
idle chan int: 字段（通道；类型 chan int）
max_idle int: 字段（int）

`new_pool`

XuAPI

pub fn new_pool(url string, max_idle int) Pool

用途

构造 pool。

参数

url string: url（string）
max_idle int: max_idle（int）

Pool — 该类型的值

`new_pool_auth`

XuAPI

pub fn new_pool_auth(url string, user string, pass string, max_idle int) Pool

用途

构造 pool auth。

参数

url string: url（string）
user string: user（string）
pass string: pass（string）
max_idle int: max_idle（int）

Pool — 该类型的值

`(&Pool) get`

XuAPI

pub fn (p &Pool) get() Client

用途

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

参数

p &Pool: 接收者 &Pool（借用）

Client — 该类型的值

`(&Pool) put_conn`

XuAPI

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

用途

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

参数

p &Pool: 接收者 &Pool（借用）
fd int: 文件描述符（int）

`(&Pool) put`

XuAPI

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

用途

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

参数

p &Pool: 接收者 &Pool（借用）
c Client: 字节或字符码（Client）

`(&Pool) publish`

XuAPI

pub fn (p &Pool) publish(subject string, data string) int

用途

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

参数

p &Pool: 接收者 &Pool（借用）
subject string: subject（string）
data string: 数据（string）

int — 该类型的值

`(&Pool) close`

XuAPI

pub fn (p &Pool) close()

用途

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

参数

p &Pool: 接收者 &Pool（借用）

`struct Subscription`

XuAPI

pub struct Subscription {
    pub sid string
    pub subject string
    pub queue_group string
}

用途

公开结构体 `Subscription`。

参数

sid string: 字段（string）
subject string: 字段（string）
queue_group string: 字段（string）

`new_sub`

XuAPI

pub fn new_sub(sid string, subject string, queue_group string) Subscription

用途

构造 sub。

参数

sid string: sid（string）
subject string: subject（string）
queue_group string: queue_group（string）

Subscription — 该类型的值