src/dma/vendor/github.com/streadway/amqp/README.md

   1 [![Build Status](https://api.travis-ci.org/streadway/amqp.svg)](http://travis-ci.org/streadway/amqp) [![GoDoc](https://godoc.org/github.com/streadway/amqp?status.svg)](http://godoc.org/github.com/streadway/amqp)
   2
   3 # Go RabbitMQ Client Library
   4
   5 This is an AMQP 0.9.1 client with RabbitMQ extensions in Go.
   6
   7 ## Project Maturity
   8
   9 This project has been used in production systems for many years. It is reasonably mature
  10 and feature complete, and as of November 2016 has [a team of maintainers](https://github.com/streadway/amqp/issues/215).
  11
  12 Future API changes are unlikely but possible. They will be discussed on [Github
  13 issues](https://github.com/streadway/amqp/issues) along with any bugs or
  14 enhancements.
  15
  16 ## Supported Go Versions
  17
  18 This library supports two most recent Go release series, currently 1.10 and 1.11.
  19
  20
  21 ## Supported RabbitMQ Versions
  22
  23 This project supports RabbitMQ versions starting with `2.0` but primarily tested
  24 against reasonably recent `3.x` releases. Some features and behaviours may be
  25 server version-specific.
  26
  27 ## Goals
  28
  29 Provide a functional interface that closely represents the AMQP 0.9.1 model
  30 targeted to RabbitMQ as a server.  This includes the minimum necessary to
  31 interact the semantics of the protocol.
  32
  33 ## Non-goals
  34
  35 Things not intended to be supported.
  36
  37   * Auto reconnect and re-synchronization of client and server topologies.
  38     * Reconnection would require understanding the error paths when the
  39       topology cannot be declared on reconnect.  This would require a new set
  40       of types and code paths that are best suited at the call-site of this
  41       package.  AMQP has a dynamic topology that needs all peers to agree. If
  42       this doesn't happen, the behavior is undefined.  Instead of producing a
  43       possible interface with undefined behavior, this package is designed to
  44       be simple for the caller to implement the necessary connection-time
  45       topology declaration so that reconnection is trivial and encapsulated in
  46       the caller's application code.
  47   * AMQP Protocol negotiation for forward or backward compatibility.
  48     * 0.9.1 is stable and widely deployed.  Versions 0.10 and 1.0 are divergent
  49       specifications that change the semantics and wire format of the protocol.
  50       We will accept patches for other protocol support but have no plans for
  51       implementation ourselves.
  52   * Anything other than PLAIN and EXTERNAL authentication mechanisms.
  53     * Keeping the mechanisms interface modular makes it possible to extend
  54       outside of this package.  If other mechanisms prove to be popular, then
  55       we would accept patches to include them in this package.
  56
  57 ## Usage
  58
  59 See the 'examples' subdirectory for simple producers and consumers executables.
  60 If you have a use-case in mind which isn't well-represented by the examples,
  61 please file an issue.
  62
  63 ## Documentation
  64
  65 Use [Godoc documentation](http://godoc.org/github.com/streadway/amqp) for
  66 reference and usage.
  67
  68 [RabbitMQ tutorials in
  69 Go](https://github.com/rabbitmq/rabbitmq-tutorials/tree/master/go) are also
  70 available.
  71
  72 ## Contributing
  73
  74 Pull requests are very much welcomed.  Create your pull request on a non-master
  75 branch, make sure a test or example is included that covers your change and
  76 your commits represent coherent changes that include a reason for the change.
  77
  78 To run the integration tests, make sure you have RabbitMQ running on any host,
  79 export the environment variable `AMQP_URL=amqp://host/` and run `go test -tags
  80 integration`.  TravisCI will also run the integration tests.
  81
  82 Thanks to the [community of contributors](https://github.com/streadway/amqp/graphs/contributors).
  83
  84 ## External packages
  85
  86   * [Google App Engine Dialer support](https://github.com/soundtrackyourbrand/gaeamqp)
  87   * [RabbitMQ examples in Go](https://github.com/rabbitmq/rabbitmq-tutorials/tree/master/go)
  88
  89 ## License
  90
  91 BSD 2 clause - see LICENSE for more details.
  92
  93