Chapter 1. Overview
AMQ Ruby is a library for developing messaging applications. It enables you to write Ruby applications that send and receive AMQP messages.
The AMQ Ruby client is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
For more information about the support scope of Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/.
AMQ Ruby is part of AMQ Clients, a suite of messaging libraries supporting multiple languages and platforms. For an overview of the clients, see AMQ Clients Overview. For information about this release, see AMQ Clients 2.3 Release Notes.
AMQ Ruby is based on the Proton API from Apache Qpid.
1.1. Key features
- An event-driven API that simplifies integration with existing applications
- SSL/TLS for secure communication
- Flexible SASL authentication
- Automatic reconnect and failover
- Seamless conversion between AMQP and language-native data types
- Access to all the features and capabilities of AMQP 1.0
1.2. Supported standards and protocols
AMQ Ruby supports the following industry-recognized standards and network protocols:
- Version 1.0 of the Advanced Message Queueing Protocol (AMQP)
- Versions 1.0, 1.1, and 1.2 of the Transport Layer Security (TLS) protocol, the successor to SSL
- Simple Authentication and Security Layer (SASL) mechanisms supported by Cyrus SASL, including ANONYMOUS, PLAIN, SCRAM, EXTERNAL, and GSSAPI (Kerberos)
- Modern TCP with IPv6
1.3. Supported configurations
AMQ Ruby is supported on Red Hat Enterprise Linux 7 with Ruby 2.0.
For more information, see Red Hat AMQ 7 Supported Configurations.
1.4. Terms and concepts
This section introduces the core API entities and describes how they operate together.
Table 1.1. API terms
A top-level container of connections
A channel for communication between two peers on a network
A context for sending and receiving messages
A channel for sending messages to a target
A channel for receiving messages from a source
A named point of origin for messages
A named destination for messages
A mutable holder of application data
A message transfer
AMQ Ruby sends and receives messages. Messages are transferred between connected peers over senders and receivers. Senders and receivers are established over sessions. Sessions are established over connections. Connections are established between two uniquely identified containers. Though a connection can have multiple sessions, often this is not needed. The API allows you to ignore sessions unless you require them.
A sending peer creates a sender to send messages. The sender has a target that identifies a queue or topic at the remote peer. A receiving peer creates a receiver to receive messages. The receiver has a source that identifies a queue or topic at the remote peer.
The sending of a message is called a delivery. The message is the content sent, including all metadata such as headers and annotations. The delivery is the protocol exchange associated with the transfer of that content.
To indicate that a delivery is complete, either the sender or the receiver settles it. When the other side learns that it has been settled, it will no longer communicate about that delivery. The receiver can also indicate whether it accepts or rejects the message.
1.5. Document conventions
This document uses the following conventions for the
sudo command and file paths.
In this document,
sudo is used for any command that requires root privileges. You should always exercise caution when using
sudo, as any changes can affect the entire system.
For more information about using
sudo, see The
About the use of file paths in this document
In this document, all file paths are valid for Linux, UNIX, and similar operating systems (for example,
/home/...). If you are using Microsoft Windows, you should use the equivalent Microsoft Windows paths (for example,