go-xmpp/doc.go

43 lines
1.5 KiB
Go
Raw Normal View History

2018-01-10 21:00:24 +00:00
/*
Fluux XMPP is an modern and full-featured XMPP library that can be used to build clients or
server components.
2018-01-10 21:00:24 +00:00
The goal is to make simple to write modern compliant XMPP software:
2018-01-10 21:00:24 +00:00
2018-01-25 16:04:19 +00:00
- For automation (like for example monitoring of an XMPP service),
- For building connected "things" by plugging them on an XMPP server,
- For writing simple chatbots to control a service or a thing.
- For writing XMPP servers components. Fluux XMPP supports:
- XEP-0114: Jabber Component Protocol
- XEP-0355: Namespace Delegation
- XEP-0356: Privileged Entity
2018-01-10 21:09:19 +00:00
The library is designed to have minimal dependencies. For now, the library does not depend on any other library.
The library includes a StreamManager that provides features like autoreconnect exponential back-off.
The library is implementing latest versions of the XMPP specifications (RFC 6120 and RFC 6121), and includes
support for many extensions.
2018-01-25 22:02:01 +00:00
Clients
Fluux XMPP can be use to create fully interactive XMPP clients (for
example console-based), but it is more commonly used to build automated
clients (connected devices, automation scripts, chatbots, etc.).
Components
XMPP components can typically be used to extends the features of an XMPP
server, in a portable way, using component protocol over persistent TCP
serverConnections.
2018-01-25 22:02:01 +00:00
2018-01-25 22:20:22 +00:00
Component protocol is defined in XEP-114 (https://xmpp.org/extensions/xep-0114.html).
2018-01-25 22:02:01 +00:00
Compliance
2018-01-25 22:04:08 +00:00
Fluux XMPP has been primarily tested with ejabberd (https://www.ejabberd.im)
2018-01-25 22:02:01 +00:00
but it should work with any XMPP compliant server.
2018-01-10 21:00:24 +00:00
*/
package xmpp