# ircxd v1.1.0 - Table of Contents

> IRC client library and embeddable IRC server for Elixir applications, with Modern IRC and IRCv3 support.

## Pages

- [ircxd - IRC client &amp; server library for Elixir](readme.md)

- Guides
  - [Client usage and adapters](client-adapters.md)
  - [Development](development.md)
  - [Server adapters](server-adapters.md)

## Modules

- [Ircxd](Ircxd.md): Ircxd is an IRC server and client library for Elixir applications.
- [Ircxd.AccountExtban](Ircxd.AccountExtban.md): Helpers for IRCv3 account extended-ban masks.

- [Ircxd.Batch](Ircxd.Batch.md): Parser helpers for IRCv3 BATCH messages.

- [Ircxd.CTCP](Ircxd.CTCP.md): Helpers for Client-To-Client Protocol payloads.
- [Ircxd.Casemapping](Ircxd.Casemapping.md): IRC casemapping helpers.
- [Ircxd.ChatHistory](Ircxd.ChatHistory.md): Helpers for the IRCv3 draft chathistory extension.

- [Ircxd.Client](Ircxd.Client.md): Provides a supervised IRC client and command functions.
- [Ircxd.Client.Adapter](Ircxd.Client.Adapter.md): Application integration contract for an `Ircxd.Client` process.
- [Ircxd.Client.Event](Ircxd.Client.Event.md): Canonical client event envelope and public event-name catalog.
- [Ircxd.Client.Info](Ircxd.Client.Info.md): Secret-free snapshot of protocol state cached by an `Ircxd.Client` process.
- [Ircxd.ClientCommand](Ircxd.ClientCommand.md): Parses and validates a client-to-server IRC command line.
- [Ircxd.ClientTagDeny](Ircxd.ClientTagDeny.md): Helpers for the IRCv3 `CLIENTTAGDENY` ISUPPORT token.

- [Ircxd.CommandSpec](Ircxd.CommandSpec.md): Protocol-owned metadata for commands sent by `Ircxd.Client`.
- [Ircxd.DCC](Ircxd.DCC.md): Helpers for CTCP DCC query payloads.
- [Ircxd.FileHost](Ircxd.FileHost.md): Helpers for the work-in-progress `soju.im/FILEHOST` ISUPPORT token.

- [Ircxd.Formatting](Ircxd.Formatting.md): Parser helpers for common IRC formatting control codes.
- [Ircxd.ISupport](Ircxd.ISupport.md): Parser for `RPL_ISUPPORT` (`005`) tokens.

- [Ircxd.Message](Ircxd.Message.md): Parser and serializer for IRC messages.
- [Ircxd.Metadata](Ircxd.Metadata.md): Parser helpers for the IRCv3 draft metadata extension.

- [Ircxd.Monitor](Ircxd.Monitor.md): Parser helpers for IRCv3 MONITOR replies.

- [Ircxd.Multiline](Ircxd.Multiline.md): Helpers for the IRCv3 draft multiline extension.

- [Ircxd.Names](Ircxd.Names.md): Parser helpers for `RPL_NAMREPLY` (`353`) entries.

- [Ircxd.SASL](Ircxd.SASL.md): SASL helpers for IRC authentication.
- [Ircxd.STS](Ircxd.STS.md): Parser helpers for the IRCv3 Strict Transport Security capability.

- [Ircxd.Server](Ircxd.Server.md): Provides an embeddable IRC server.
- [Ircxd.Server.Adapter](Ircxd.Server.Adapter.md): Application-owned server integration contract.
- [Ircxd.Server.Adapters.ETS](Ircxd.Server.Adapters.ETS.md): Supported in-memory `Ircxd.Server.Adapter` backed by private ETS tables.
- [Ircxd.Server.Event](Ircxd.Server.Event.md): A committed server-domain event delivered to an `Ircxd.Server.Adapter`.
- [Ircxd.Source](Ircxd.Source.md): Parser for IRC message sources.
- [Ircxd.StandardReply](Ircxd.StandardReply.md): Parser helpers for IRCv3 standard replies.

- [Ircxd.Tags](Ircxd.Tags.md): Convenience helpers for common IRCv3 message tags.

- [Ircxd.UserHost](Ircxd.UserHost.md): Parser helpers for `RPL_USERHOST` (`302`) replies.

- [Ircxd.WebIRC](Ircxd.WebIRC.md): Helpers for the IRCv3 WebIRC command.

- [Ircxd.WebSocket](Ircxd.WebSocket.md): Helpers for the IRCv3 WebSocket transport conventions.
- [Ircxd.WebSocket.Adapter](Ircxd.WebSocket.Adapter.md): Behaviour for host-application WebSocket adapters.
- [Ircxd.WebSocket.MemoryAdapter](Ircxd.WebSocket.MemoryAdapter.md): In-memory `Ircxd.WebSocket.Adapter` implementation.
- [Ircxd.Who](Ircxd.Who.md): Parsers for WHO/WHOX replies.

- [Ircxd.Whois](Ircxd.Whois.md): Parser helpers for WHOIS numerics.

