diff --git a/channels/manager.go b/channels/manager.go index 539d1a4e2734f0715f3e179dc64d3cf6244412f5..cfb01721b112a1a5dc7c0160da280c73fed3b9f1 100644 --- a/channels/manager.go +++ b/channels/manager.go @@ -10,25 +10,6 @@ // replies, reactions, and eventually admin commands. package channels -// on sending, data propagates as follows: -// Send function (Example: SendMessage) - > SendGeneric -> -// Broadcast.BroadcastWithAssembler -> cmix.SendWithAssembler - -// on receiving messages propagate as follows: -// cmix message pickup (by service)- > broadcast.Processor -> -// userListener -> events.triggerEvent -> -// messageTypeHandler (example: Text) -> -// eventModel (example: ReceiveMessage) - -// on sendingAdmin, data propagates as follows: -// Send function - > SendAdminGeneric -> -// Broadcast.BroadcastAsymmetricWithAssembler -> cmix.SendWithAssembler - -// on receiving admin messages propagate as follows: -// cmix message pickup (by service)- > broadcast.Processor -> adminListener -> -// events.triggerAdminEvent -> messageTypeHandler (example: Text) -> -// eventModel (example: ReceiveMessage) - import ( "gitlab.com/elixxir/client/broadcast" "gitlab.com/elixxir/client/storage/versioned" diff --git a/channels/readme.md b/channels/readme.md new file mode 100644 index 0000000000000000000000000000000000000000..9327e9635afd9c109054bf7b486d24c97a53c0bc --- /dev/null +++ b/channels/readme.md @@ -0,0 +1,21 @@ +Channels provides a channels implementation on top of broadcast which is capable of handing the user facing features of +channels, including replies, reactions, and eventually admin commands. + +on sending, data propagates as follows: +Send function (Example: SendMessage) - > SendGeneric -> +Broadcast.BroadcastWithAssembler -> cmix.SendWithAssembler + +on receiving messages propagate as follows: +cmix message pickup (by service)- > broadcast.Processor -> +userListener -> events.triggerEvent -> +messageTypeHandler (example: Text) -> +eventModel (example: ReceiveMessage) + +on sendingAdmin, data propagates as follows: +Send function - > SendAdminGeneric -> +Broadcast.BroadcastAsymmetricWithAssembler -> cmix.SendWithAssembler + +on receiving admin messages propagate as follows: +cmix message pickup (by service)- > broadcast.Processor -> adminListener -> +events.triggerAdminEvent -> messageTypeHandler (example: Text) -> +eventModel (example: ReceiveMessage) \ No newline at end of file