Welcome to the prime page for developer documentation on Prosody.
Also useful to you, whether writing a module or working on core Prosody code, will be our Utility APIs.
We also have documentation on the various common data structures that Prosody uses internally.
If after reading this you are still clueless, or can't find what you were looking for, you are strongly encouraged to contact us! We also welcome anyone wanting to contribute to the project itself or the documentation.
These modules are designed to provide a unified API for both core and module developers. They help with common tasks, and provide useful data structures.
|util.datamanager||Allows persistent storage and retrieval of data|
|util.datetime API||Retrieve the current or specified time in various XMPP formats|
|util.encodings API||Encode/decode data using algorithms such as base64, IDNA, stringprep|
|util.events API||Library to abstract the firing and handling of named events|
|util.hashes API||Calculate hashes of input data using MD5, SHA1, SHA256, etc.|
|util.jid API||Common functions for splitting and prepping JIDs|
|util.logger||An interface to Prosody's logging system|
|util.multitable||A multitable is a handy tree-like data structure, a table allowing multiple keys|
|util.serialization||Convert objects into a format suitable to save to disk or send across the network|
|util.timer API||Set callbacks to be called after a specified delay|
|util.stanza||Create and manipulate stanzas and other XML objects|
|util.uuid API||Generate unique string identifiers|
These are prosody modules that have an API that can be used from other modules, or manage data in a format that needs documentation.