# firemq v0.1.0 - Table of Contents

> Elixir client for FireMQ over the native FireMQ protocol

## Pages

- [firemq-elixir](readme.md)
- [LICENSE](license.md)

## Modules

- [FireMQ](FireMQ.md): Elixir client for [FireMQ](https://github.com/FireMQ/firemq), over the native FireMQ
protocol.
- [FireMQ.Connection](FireMQ.Connection.md): A connection to FireMQ: a process that owns one TCP or TLS socket.
- [FireMQ.Frame](FireMQ.Frame.md): Encodes and decodes FireMQ protocol frames.
- [FireMQ.Message](FireMQ.Message.md): A message received with `FireMQ.subscribe/3` or `FireMQ.get/3`.
- [FireMQ.QueueInfo](FireMQ.QueueInfo.md): What `FireMQ.declare_queue/3` reports: the queue's name (useful when the broker picked
it), how many messages are ready, and how many consumers it has.

- [FireMQ.URL](FireMQ.URL.md): Parses connection URLs.

- Exceptions
  - [FireMQ.Error](FireMQ.Error.md): An error returned by the client.