API

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

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

counts: 18 函数, 20 方法, 4 类型, 10 常量, 0 方法集

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

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

`open`

XuAPI

pub fn open(host string, port int, user string, password string, vhost string) Client

用途

打开。

参数

host string: 主机（string）
port int: 端口（int）
user string: user（string）
password string: password（string）
vhost string: vhost（string）

Client — 该类型的值

`open_default`

XuAPI

pub fn open_default() Client

用途

打开default。

参数

无

Client — 该类型的值

`struct Message`

XuAPI

pub struct Message {
    pub exchange string
    pub routing_key string
    pub body string
    pub message_count int
}

用途

公开结构体 `Message`。

参数

exchange string: 字段（string）
routing_key string: 字段（string）
body string: 正文
message_count int: 字段（int）

`struct Client`

XuAPI

pub struct Client {
    pub fd int
    pub host string
    pub port int
    pub user string
    pub password string
    pub vhost string
    pub channel_id int
}

用途

公开结构体 `Client`。

参数

fd int: 文件描述符
host string: 主机
port int: 端口
user string: 字段（string）
password string: 字段（string）
vhost string: 字段（string）
channel_id int: 字段（int）

`(&mut Client) write_exact`

XuAPI

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

用途

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

参数

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

int — 该类型的值

`(&mut Client) read_exact`

XuAPI

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

用途

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

参数

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

string — 结果字符串

`(&mut Client) send_frame`

XuAPI

pub fn (c &mut Client) send_frame(frame_type int, channel int, payload string) int

用途

`&mut Client` 上的方法：sendframe。

参数

c &mut Client: 接收者 &mut Client（可变借用）
frame_type int: frame_type（int）
channel int: channel（int）
payload string: payload（string）

int — 该类型的值

`(&mut Client) read_frame`

XuAPI

pub fn (c &mut Client) read_frame() Frame

用途

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

参数

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

Frame — 该类型的值

`connect`

XuAPI

pub fn connect(host string, port int, user string, password string, vhost string) Client

用途

connect，返回 Client。失败时 throw。

参数

host string: 主机（string）
port int: 端口（int）
user string: user（string）
password string: password（string）
vhost string: vhost（string）

Client — 该类型的值

`(&mut Client) declare_queue`

XuAPI

pub fn (c &mut Client) declare_queue(queue_name string, durable bool) int

用途

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

参数

c &mut Client: 接收者 &mut Client（可变借用）
queue_name string: queue_name（string）
durable bool: durable（bool）

int — 该类型的值

`(&mut Client) declare_exchange`

XuAPI

pub fn (c &mut Client) declare_exchange(exchange_name string, exchange_type string, durable bool) int

用途

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

参数

c &mut Client: 接收者 &mut Client（可变借用）
exchange_name string: exchange_name（string）
exchange_type string: exchange_type（string）
durable bool: durable（bool）

int — 该类型的值

`(&mut Client) bind_queue`

XuAPI

pub fn (c &mut Client) bind_queue(queue_name string, exchange_name string, routing_key string) int

用途

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

参数

c &mut Client: 接收者 &mut Client（可变借用）
queue_name string: queue_name（string）
exchange_name string: exchange_name（string）
routing_key string: routing_key（string）

int — 该类型的值

`(&mut Client) publish`

XuAPI

pub fn (c &mut Client) publish(exchange_name string, routing_key string, message_body string) int

用途

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

参数

c &mut Client: 接收者 &mut Client（可变借用）
exchange_name string: exchange_name（string）
routing_key string: routing_key（string）
message_body string: message_body（string）

int — 该类型的值

`(&mut Client) get`

XuAPI

pub fn (c &mut Client) get(queue_name string, auto_ack bool) string

用途

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

参数

c &mut Client: 接收者 &mut Client（可变借用）
queue_name string: queue_name（string）
auto_ack bool: auto_ack（bool）

string — 结果字符串

`(&mut Client) ping`

XuAPI

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

用途

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

参数

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

bool — 是否成立

`(&mut Client) close`

XuAPI

pub fn (c &mut Client) close()

用途

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

参数

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

`struct Pool`

XuAPI

pub struct Pool {
    pub host string
    pub port int
    pub user string
    pub password string
    pub vhost string
    pub idle chan int
    pub max_idle int
}

用途

公开结构体 `Pool`。

参数

host string: 主机
port int: 端口
user string: 字段（string）
password string: 字段（string）
vhost string: 字段（string）
idle chan int: 字段（通道；类型 chan int）
max_idle int: 字段（int）

`new_pool`

XuAPI

pub fn new_pool(host string, port int, user string, password string, vhost string, max_idle int) Pool

用途

构造 pool。

参数

host string: 主机（string）
port int: 端口（int）
user string: user（string）
password string: password（string）
vhost string: vhost（string）
max_idle int: max_idle（int）

Pool — 该类型的值

`open_pool`

XuAPI

pub fn open_pool(host string, port int, user string, password string, vhost string, max_idle int) Pool

用途

打开pool。

参数

host string: 主机（string）
port int: 端口（int）
user string: user（string）
password string: password（string）
vhost string: vhost（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) get_conn`

XuAPI

pub fn (p &Pool) get_conn() int

用途

`&Pool` 上的方法：读取 conn。

参数

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

int — 该类型的值

`(&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) declare_queue`

XuAPI

pub fn (p &Pool) declare_queue(queue_name string, durable bool) int

用途

`&Pool` 上的方法：declarequeue。失败时 throw。

参数

p &Pool: 接收者 &Pool（借用）
queue_name string: queue_name（string）
durable bool: durable（bool）

int — 该类型的值

`(&Pool) publish`

XuAPI

pub fn (p &Pool) publish(exchange_name string, routing_key string, body string) int

用途

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

参数

p &Pool: 接收者 &Pool（借用）
exchange_name string: exchange_name（string）
routing_key string: routing_key（string）
body string: 正文（string）

int — 该类型的值

`(&Pool) get_message`

XuAPI

pub fn (p &Pool) get_message(queue_name string, auto_ack bool) string

用途

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

参数

p &Pool: 接收者 &Pool（借用）
queue_name string: queue_name（string）
auto_ack bool: auto_ack（bool）

string — 结果字符串

`(&Pool) ping`

XuAPI

pub fn (p &Pool) ping() bool

用途

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

参数

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

bool — 是否成立

`(&Pool) close`

XuAPI

pub fn (p &Pool) close()

用途

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

参数

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

`const frame_method`

XuAPI

pub const frame_method = 1

用途

公开常量 `frame_method`。值为 `1`

参数

无

`const frame_header`

XuAPI

pub const frame_header = 2

用途

公开常量 `frame_header`。值为 `2`

参数

无

`const frame_body`

XuAPI

pub const frame_body = 3

用途

公开常量 `frame_body`。值为 `3`

参数

无

`const frame_heartbeat`

XuAPI

pub const frame_heartbeat = 8

用途

公开常量 `frame_heartbeat`。值为 `8`

参数

无

`const frame_end`

XuAPI

pub const frame_end = 206

用途

公开常量 `frame_end`。值为 `206`

参数

无

`const class_connection`

XuAPI

pub const class_connection = 10

用途

公开常量 `class_connection`。值为 `10`

参数

无

`const class_channel`

XuAPI

pub const class_channel = 20

用途

公开常量 `class_channel`。值为 `20`

参数

无

`const class_exchange`

XuAPI

pub const class_exchange = 40

用途

公开常量 `class_exchange`。值为 `40`

参数

无

`const class_queue`

XuAPI

pub const class_queue = 50

用途

公开常量 `class_queue`。值为 `50`

参数

无

`const class_basic`

XuAPI

pub const class_basic = 60

用途

公开常量 `class_basic`。值为 `60`

参数

无

`struct Frame`

XuAPI

pub struct Frame {
    pub frame_type int
    pub channel int
    pub payload string
}

用途

公开结构体 `Frame`。

参数

frame_type int: 字段（int）
channel int: 字段（int）
payload string: 字段（string）

`encode_i8`

XuAPI

pub fn encode_i8(v int) string

用途

编码。

参数

v int: 值（int）

string — 结果字符串

`encode_i16`

XuAPI

pub fn encode_i16(v int) string

用途

编码。

参数

v int: 值（int）

string — 结果字符串

`encode_i32`

XuAPI

pub fn encode_i32(v int) string

用途

编码。

参数

v int: 值（int）

string — 结果字符串

`encode_i64`

XuAPI

pub fn encode_i64(v int) string

用途

编码。

参数

v int: 值（int）

string — 结果字符串

`decode_i8`

XuAPI

pub fn decode_i8(s string, off int) int

用途

解码。

参数

s string: 源字符串（string）
off int: 偏移（int）

int — 该类型的值

`decode_i16`

XuAPI

pub fn decode_i16(s string, off int) int

用途

解码。

参数

s string: 源字符串（string）
off int: 偏移（int）

int — 该类型的值

`decode_i32`

XuAPI

pub fn decode_i32(s string, off int) int

用途

解码。

参数

s string: 源字符串（string）
off int: 偏移（int）

int — 该类型的值

`decode_i64`

XuAPI

pub fn decode_i64(s string, off int) int

用途

解码。

参数

s string: 源字符串（string）
off int: 偏移（int）

int — 该类型的值

`encode_shortstr`

XuAPI

pub fn encode_shortstr(s string) string

用途

编码。

参数

s string: 源字符串（string）

string — 结果字符串

`encode_longstr`

XuAPI

pub fn encode_longstr(s string) string

用途

编码。

参数

s string: 源字符串（string）

string — 结果字符串

`encode_empty_table`

XuAPI

pub fn encode_empty_table() string

用途

编码。

参数

无

string — 结果字符串

`build_frame`

XuAPI

pub fn build_frame(frame_type int, channel int, payload string) string

用途

buildframe。

参数

frame_type int: frame_type（int）
channel int: channel（int）
payload string: payload（string）

string — 结果字符串

`build_method_payload`

XuAPI

pub fn build_method_payload(class_id int, method_id int, arguments string) string

用途

buildmethodpayload。

参数

class_id int: class_id（int）
method_id int: method_id（int）
arguments string: arguments（string）

string — 结果字符串