Crate mqi

Expand description

§Overview

Idiomatic Rust API’s to the IBM® MQ Interface (MQI) and MQ Administration Interface (MQAI).

You can use mqi to:

Connect to an IBM MQ server to send and receive MQ messages through the MQI functions
Administer IBM MQ server through the MQAI functions

This crate depends on the libmqm-sys crate for connectivity to MQ queue managers. The underlying connection uses the IBM supplied MQ libraries, offering proven stability and performance.

§Feature Flags

tracing — Enable tracing in the MQI calls
mqai — Enable the administrative API
exits — Enable the exits API
link (enabled by default) — Link the MQI library at compile time
dlopen2 — Enable runtime loading of the MQI library using dlopen2
mock — MQI and MQAI function mocking for unit and integration tests
mqc_9_2_0_0 (enabled by default) — Minimum MQ client version 9.2.0.0
mqc_9_4_3_0 — Minimum MQ client version 9.4.3.0
mqc_latest — Minimum MQ client version latest release

MQI function	Crate function(s)
`MQCONN`	Not used
`MQCONNX`	`connect`, `connect_as`, `connect_with`, `connect_lib`, `connect_lib_with`
`MQPUT1`	`Connection::put_message`, `Connection::put_message_with`
`MQDISC`	`Connection::disconnect`, `Connection::drop`
`MQOPEN`	`Object::open`, `Object::open_with`
`MQGET`	`Object::get_data`, `Object::get_data_with`, `Object::get_string`, `Object::get_string_with`, `Object::get_as`
`MQPUT`	`Object::put_message`, `Object::put_message_with`
`MQINQ`	`Object::inquire`
`MQSET`	`Object::set`
`MQCLOSE`	`Object::close`, `Object::drop`, `Subscription::close`, `Subscription::drop`
`MQSUB`	`Subscription::subscribe`, `Subscription::subscribe_with`, `Subscription::subscribe_managed`, `Subscription::subscribe_managed_with`
`MQSUBRQ`	`Subscription::request_retained`
`MQCRTMH`	`Properties::new`
`MQINQMP`	`Properties::property`, `Properties::property_iter`
`MQSETMP`	`Properties::set_property`
`MQDLTMP`	`Properties::delete_property`
`MQBUFMH`	`Properties::from_buffer`, `Properties::from_buffer_mut`
`MQMHBUF`	`Properties::to_buffer`, `Properties::to_buffer_mut`
`MQDLTMH`	`Properties::close`, `Properties::drop`
`MQSTAT`	`Connection::stat_put`, `Connection::stat_reconnection`, `Connection::stat_reconnection_error`
`MQBEGIN`	`Syncpoint::begin`
`MQBACK`	`Syncpoint::backout`
`MQCMIT`	`Syncpoint::commit`
`MQCB`	`EventCallback::register_event_handler`
`MQCTL`	Not implemented yet

MQAI function	Crate function(s)
`mqCreateBag`	`Bag::new`, `Bag::new_lib`
`mqClearBag`	`Bag::clear`
`mqDeleteBag`	`Bag::drop`
`mqGetBag`	`Object::get_bag`, `Object::get_bag_with`
`mqPutBag`	`Object::put_bag`, `Object::put_bag_with`
`mqTruncateBag`	`Bag::truncate`
`mqAddInquiry`	`Bag::add_inquiry`
`mqDeleteItem`	`Bag::delete`
`mqAddInteger`	`Bag::add` with `MQLONG`
`mqAddIntegerFilter`	`Bag::add` with `Filter<MQLONG>`
`mqAddInteger64`	`Bag::add` with `MQINT64`
`mqAddString`	`Bag::add` with `EncodedString`
`mqAddStringFilter`	`Bag::add` with `Filter<impl EncodedString>`
`mqAddByteString`	`Bag::add` with [`MQBYTE`]
`mqAddByteStringFilter`	`Bag::add` with `Filter<&[MQBYTE]>`
`mqSetInteger`	`Bag::set` with `MQLONG`
`mqSetIntegerFilter`	`Bag::set` with `Filter<MQLONG>`
`mqSetInteger64`	`Bag::set` with `MQINT64`
`mqAddBag`	`Bag::add` with `Bag`
`mqSetString`	`Bag::set` with `EncodedString`
`mqSetStringFilter`	`Bag::set` with `Filter<impl EncodedString>`
`mqSetByteString`	`Bag::set` with [`MQBYTE`]
`mqSetByteStringFilter`	`Bag::set` with `Filter<&[MQBYTE]>`
`mqInquireInteger`	`Bag::inquire` with `MQLONG`
`mqInquireIntegerFilter`	`Bag::inquire` with `Filter<MQLONG>`
`mqInquireInteger64`	`Bag::inquire` with `MQINT64`
`mqInquireByteString`	`Bag::inquire` with `Vec<MQBYTE>`
`mqInquireString`	`Bag::inquire` with `StringCcsidOwned`
`mqInquireStringFilter`	`Bag::inquire` with `Filter<StringCcsidOwned>`
`mqInquireByteStringFilter`	`Bag::inquire` with `Filter<Vec<MQBYTE>>`
`mqInquireBag`	`Bag::inquire` with `Bag`
`mqCountItems`	`Bag::count`
`mqExecute`	`Connection::execute`
`mqBagToBuffer`	`Bag::to_buffer`, `Bag::buffer_len`
`mqBufferToBag`	`Bag::from_buffer`
`mqInquireItemInfo`	`Bag::inquire` with (`Selector`, `MQITEM`) tuple
`mqTrim`	Not Used
`mqPad`	Not Used

Exits API	Crate function(s)
`MQXCNVC`	`StringCcsid::try_mq_convert`
`MQXEP`	Not implemented yet
`MQXCLWLN`	Not implemented yet
`MQXDX`	Not implemented yet
`MQZEP`	Not implemented yet

Modules§

attribute
bagmqai
connection
constants
executemqai
get
handle
header
open
prelude
properties
put
result
stat
string
structs
subscription
traits
types
verb

Macros§

mqstr: Define a MqStr from constant &str.

Structs§

Connection: A connection to an IBM MQ queue manager
ConnectionRef: A logical reference to a Connection
EventCallback: Manage the event handler callback of a connection
MqFunctions: A set of wrapper functions on the native IBM MQ API’s
MqStr: Fixed width string with trailing white space/nulls commonly used with IBM MQ API’s
Object: An object refers to a managed entity within IBM MQ, such as a queue, topic, channel, or queue manager
Properties: Manage message properties
Subscription: Subscription to an IBM MQ topic
Syncpoint: Manage the state of syncpoint of a connection

Traits§

Library: Holds a reference to an implementation of an MQ library
MqaiLibrarymqai

Functions§

connectlink: Create a connection to a queue manager using the compile time linked MQ library.
connect_aslink: Create a connection to a queue manager using the compile time linked MQ library and type inferred ConnectValue.
connect_lib: Create a connection to a queue manager using a Library returning a Connection.
connect_lib_as: Create a connection to a queue manager using a Library returning a usually inferred ConnectValue.
connect_lib_with: Create a connection to a queue manager using a Library returning a (Connection, impl ConnectAttr) tuple.
connect_withlink: Create a connection to a queue manager and return an implementation of ConnectAttr in tuple using the compile time linked MQ library.

Type Aliases§

MqChar

Crate mqiCopy item path