API
#github.com/xulang-org/packages/rabbitmqPublic API convenience helpers for RabbitMQ driver
github.com/xulang-org/packages · 0.1.1 · Install and use
openpub fn open(host string, port int, user string, password string, vhost string) ClientPublic API convenience helpers for RabbitMQ driver
host stringport intuser stringpassword stringvhost stringClient — a value of this type
open_defaultpub fn open_default() ClientOpen default.
none
Client — a value of this type
struct Messagepub struct Message {
pub exchange string
pub routing_key string
pub body string
pub message_count int
}Public struct `Message`.
exchange stringrouting_key stringbody stringmessage_count intstruct Clientpub struct Client {
pub fd int
pub host string
pub port int
pub user string
pub password string
pub vhost string
pub channel_id int
}Public struct `Client`.
fd inthost stringport intuser stringpassword stringvhost stringchannel_id int(&mut Client) write_exactpub fn (c &mut Client) write_exact(data string) intMethod on `&mut Client`: write exact. Throws on failure.
c &mut Clientdata stringint — a value of this type
(&mut Client) read_exactpub fn (c &mut Client) read_exact(n int) stringMethod on `&mut Client`: read exact. Throws on failure.
c &mut Clientn intstring — result string
(&mut Client) send_framepub fn (c &mut Client) send_frame(frame_type int, channel int, payload string) intMethod on `&mut Client`: send frame.
c &mut Clientframe_type intchannel intpayload stringint — a value of this type
(&mut Client) read_framepub fn (c &mut Client) read_frame() FrameMethod on `&mut Client`: read frame. Throws on failure.
c &mut ClientFrame — a value of this type
connectpub fn connect(host string, port int, user string, password string, vhost string) Clientconnect; returns Client. Throws on failure.
host stringport intuser stringpassword stringvhost stringClient — a value of this type
(&mut Client) declare_queuepub fn (c &mut Client) declare_queue(queue_name string, durable bool) intMethod on `&mut Client`: declare queue. Throws on failure.
c &mut Clientqueue_name stringdurable boolint — a value of this type
(&mut Client) declare_exchangepub fn (c &mut Client) declare_exchange(exchange_name string, exchange_type string, durable bool) intMethod on `&mut Client`: declare exchange. Throws on failure.
c &mut Clientexchange_name stringexchange_type stringdurable boolint — a value of this type
(&mut Client) bind_queuepub fn (c &mut Client) bind_queue(queue_name string, exchange_name string, routing_key string) intMethod on `&mut Client`: bind queue. Throws on failure.
c &mut Clientqueue_name stringexchange_name stringrouting_key stringint — a value of this type
(&mut Client) publishpub fn (c &mut Client) publish(exchange_name string, routing_key string, message_body string) intCall `publish` on `&mut Client`. Throws on failure.
c &mut Clientexchange_name stringrouting_key stringmessage_body stringint — a value of this type
(&mut Client) getpub fn (c &mut Client) get(queue_name string, auto_ack bool) stringCall `get` on `&mut Client`. Throws on failure.
c &mut Clientqueue_name stringauto_ack boolstring — result string
(&mut Client) pingpub fn (c &mut Client) ping() boolCall `ping` on `&mut Client`.
c &mut Clientbool — true or false
(&mut Client) closepub fn (c &mut Client) close()Method on `&mut Client`: close the resource.
c &mut Clientstruct Poolpub 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
}Connection Pool for RabbitMQ AMQP 0-9-1. Manages reusable TCP client connections and channels via scalar channel.
host stringport intuser stringpassword stringvhost stringidle chan intmax_idle intnew_poolpub fn new_pool(host string, port int, user string, password string, vhost string, max_idle int) PoolConstruct pool.
host stringport intuser stringpassword stringvhost stringmax_idle intPool — a value of this type
open_poolpub fn open_pool(host string, port int, user string, password string, vhost string, max_idle int) PoolOpen pool.
host stringport intuser stringpassword stringvhost stringmax_idle intPool — a value of this type
(&Pool) getpub fn (p &Pool) get() ClientCall `get` on `&Pool`. Throws on failure.
p &PoolClient — a value of this type
(&Pool) get_connpub fn (p &Pool) get_conn() intMethod on `&Pool`: read conn.
p &Poolint — a value of this type
(&Pool) put_connpub fn (p &Pool) put_conn(fd int)Method on `&Pool`: put connection.
p &Poolfd int(&Pool) putpub fn (p &Pool) put(c Client)Call `put` on `&Pool`.
p &Poolc Client(&Pool) declare_queuepub fn (p &Pool) declare_queue(queue_name string, durable bool) intMethod on `&Pool`: declare queue. Throws on failure.
p &Poolqueue_name stringdurable boolint — a value of this type
(&Pool) publishpub fn (p &Pool) publish(exchange_name string, routing_key string, body string) intCall `publish` on `&Pool`. Throws on failure.
p &Poolexchange_name stringrouting_key stringbody stringint — a value of this type
(&Pool) get_messagepub fn (p &Pool) get_message(queue_name string, auto_ack bool) stringMethod on `&Pool`: read message. Throws on failure.
p &Poolqueue_name stringauto_ack boolstring — result string
(&Pool) pingpub fn (p &Pool) ping() boolCall `ping` on `&Pool`.
p &Poolbool — true or false
(&Pool) closepub fn (p &Pool) close()Method on `&Pool`: close the resource.
p &Poolconst frame_methodpub const frame_method = 1AMQP 0-9-1 Protocol Constants Value `1`.
none
const frame_headerpub const frame_header = 2Public constant `frame_header`. Value `2`.
none
const frame_bodypub const frame_body = 3Public constant `frame_body`. Value `3`.
none
const frame_heartbeatpub const frame_heartbeat = 8Public constant `frame_heartbeat`. Value `8`.
none
const frame_endpub const frame_end = 206Public constant `frame_end`. Value `206`.
none
const class_connectionpub const class_connection = 10Class IDs Value `10`.
none
const class_channelpub const class_channel = 20Public constant `class_channel`. Value `20`.
none
const class_exchangepub const class_exchange = 40Public constant `class_exchange`. Value `40`.
none
const class_queuepub const class_queue = 50Public constant `class_queue`. Value `50`.
none
const class_basicpub const class_basic = 60Public constant `class_basic`. Value `60`.
none
struct Framepub struct Frame {
pub frame_type int
pub channel int
pub payload string
}Frame structure
frame_type intchannel intpayload stringencode_i8pub fn encode_i8(v int) stringEncode.
v intstring — result string
encode_i16pub fn encode_i16(v int) stringEncode.
v intstring — result string
encode_i32pub fn encode_i32(v int) stringEncode.
v intstring — result string
encode_i64pub fn encode_i64(v int) stringEncode.
v intstring — result string
decode_i8pub fn decode_i8(s string, off int) intDecode.
s stringoff intint — a value of this type
decode_i16pub fn decode_i16(s string, off int) intDecode.
s stringoff intint — a value of this type
decode_i32pub fn decode_i32(s string, off int) intDecode.
s stringoff intint — a value of this type
decode_i64pub fn decode_i64(s string, off int) intDecode.
s stringoff intint — a value of this type
encode_shortstrpub fn encode_shortstr(s string) stringShort string: 1-byte length prefix (0-255) + content
s stringstring — result string
encode_longstrpub fn encode_longstr(s string) stringLong string: 4-byte length prefix + content
s stringstring — result string
encode_empty_tablepub fn encode_empty_table() stringEmpty AMQP field table (4 bytes = 0 length)
none
string — result string
build_framepub fn build_frame(frame_type int, channel int, payload string) stringFrame builder
frame_type intchannel intpayload stringstring — result string
build_method_payloadpub fn build_method_payload(class_id int, method_id int, arguments string) stringMethod payload builder: Class ID (2B) + Method ID (2B) + Arguments
class_id intmethod_id intarguments stringstring — result string