amqp091-go Documentation

Technical Documentation: rabbitmq/amqp091-go

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

Go RabbitMQ Client Library

This is a Go AMQP 0.9.1 client maintained by the RabbitMQ core team.
It was originally developed by Sean Treadway.

Differences from streadway/amqp Copy Chapter

Some things are different compared to the original client,
others haven't changed.

Package Name Copy Section

This library uses a different package name. If moving from streadway/amqp,
using an alias may reduce the number of changes needed:

amqp "github.com/rabbitmq/amqp091-go"

License Copy Section

This client uses the same 2-clause BSD license as the original project.

Public API Evolution Copy Section

This client retains key API elements as practically possible.
It is, however, open to reasonable breaking public API changes suggested by the community.
We don't have the "no breaking public API changes ever" rule and fully recognize
that a good client API evolves over time.

Project Maturity Copy Chapter

This project is based on a mature Go client that's been around for over a decade.

Supported Go Versions Copy Chapter

This client supports two most recent Go release series.

Supported RabbitMQ Versions Copy Chapter

This project supports RabbitMQ versions starting with 2.0 but primarily tested
against currently supported RabbitMQ release series.

Some features and behaviours may be server version-specific.

Goals Copy Chapter

Provide a functional interface that closely represents the AMQP 0.9.1 model
targeted to RabbitMQ as a server. This includes the minimum necessary to
interact the semantics of the protocol.

Non-goals Copy Chapter

Things not intended to be supported.

• AMQP Protocol negotiation for forward or backward compatibility.
  • 0.9.1 is stable and widely deployed. AMQP 1.0 is a divergent
    specification (a different protocol) and belongs to a different library.
• Anything other than PLAIN and EXTERNAL authentication mechanisms.
  • Keeping the mechanisms interface modular makes it possible to extend
    outside of this package. If other mechanisms prove to be popular, then
    we would accept patches to include them in this package.
• Support for basic.return and basic.ack frame ordering.
  This client uses Go channels for certain protocol events and ordering between
  events sent to two different channels generally cannot be guaranteed.

Usage Copy Chapter

See the _examples subdirectory for simple producers and consumers executables.
If you have a use-case in mind which isn't well-represented by the examples,
please file an issue.

Documentation Copy Chapter

• Godoc API reference
• RabbitMQ tutorials in Go

Contributing Copy Chapter

Pull requests are very much welcomed. Create your pull request on a non-main
branch, make sure a test or example is included that covers your change, and
your commits represent coherent changes that include a reason for the change.

See CONTRIBUTING.md for more information.

License Copy Chapter

BSD 2 clause, see LICENSE for more details.

--- METRICS ---

• Files Extracted: 1
• Estimated Token Budget: ~854 tokens
• Canonical Reference: https://codewiki.google/github.com/rabbitmq/amqp091-go