MirrorHub/construct
0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2025-03-14 05:20:17 +01:00
Code Issues Releases Wiki Activity

modules/m_receipt: Add comments/docs on flow.

Browse source
This commit is contained in:
Jason Volk 2019-09-06 10:56:49 -07:00
parent 91044cf1f0
commit 7d0c44eb3c
1 changed files with 30 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
modules/m_receipt.cc
View file

@ -8,6 +8,24 @@
// copyright notice and this permission notice is present in all copies. The
// full license for this software is available in the LICENSE file.
/// There are three principal component sections in this unit:
///
/// ---------------------------------- _
/// | 1. Incoming federation EDU hook | |
/// ---------------------------------- |
/// ---------------------------------- |
/// | 2. ircd::m::receipt API | |
/// ---------------------------------- |
/// ---------------------------------- |
/// | 3. Outgoing federation EDU hook | V
/// ----------------------------------
///
/// This unit parses and accepts m.receipt EDU's from the federation (1); then
/// it calls the m::receipt API (2) which generates internal PDU's sent to
/// user rooms. Hooks on these events sent to user rooms (3) turn the events
/// into federation EDU's for broadcast (for local users). Note that there are
/// other reactives for these internal events in client/sync, etc.
using namespace ircd;
static void handle_ircd_read(const m::event &, m::vm::eval &);
@ -35,6 +53,10 @@ receipt_log
"m.receipt"
};
//
// EDU handler.
//
decltype(_m_receipt_eval)
_m_receipt_eval
{
@ -220,6 +242,10 @@ catch(const std::exception &e)
};
}
//
// m::receipt API -> Internal
//
m::event::id::buf
IRCD_MODULE_EXPORT
ircd::m::receipt::read(const m::room::id &room_id,
@ -400,6 +426,10 @@ ircd::m::receipt::exists(const m::room::id &room_id,
return ret;
}
//
// Internal -> Federation
//
decltype(_implicit_receipt)
_implicit_receipt
{