Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add message concepts doc #944

Merged
merged 37 commits into from
Nov 9, 2022
Merged
Changes from 35 commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
d72cddb
Create message.md
thulieblack Sep 12, 2022
3eab857
Merge branch 'master' into message_doc
derberg Sep 12, 2022
e63d19a
Update message.md
thulieblack Sep 14, 2022
210b7c3
Update message.md
thulieblack Sep 14, 2022
9a44d60
Update message.md
thulieblack Sep 14, 2022
20fa329
Update message.md
thulieblack Sep 14, 2022
cbcb0a5
Update message.md
thulieblack Sep 14, 2022
4376b42
Update message.md
thulieblack Sep 14, 2022
fe20dea
Update message.md
thulieblack Sep 14, 2022
9569e79
Merge branch 'master' into message_doc
quetzalliwrites Sep 20, 2022
a19a91a
Update pages/docs/concepts/message.md
thulieblack Sep 20, 2022
027cca1
Update pages/docs/concepts/message.md
thulieblack Sep 20, 2022
b3e6201
Update pages/docs/concepts/message.md
thulieblack Sep 20, 2022
9650737
Update message.md
thulieblack Sep 20, 2022
7cd16c2
Update message.md
thulieblack Sep 20, 2022
75fadc1
Merge branch 'master' into message_doc
quetzalliwrites Sep 21, 2022
5a485be
Merge branch 'asyncapi:master' into message_doc
thulieblack Sep 29, 2022
7b565db
Update message.md
thulieblack Sep 29, 2022
717978c
Update message.md
thulieblack Sep 29, 2022
dc69c6a
Merge branch 'asyncapi:master' into message_doc
thulieblack Oct 6, 2022
d93cb5e
Update message.md
thulieblack Oct 6, 2022
7649cbd
Update message.md
thulieblack Oct 10, 2022
1f2d030
Merge branch 'master' into message_doc
quetzalliwrites Oct 21, 2022
26473d3
Update pages/docs/concepts/message.md
thulieblack Oct 21, 2022
f77ae53
Merge branch 'master' into message_doc
quetzalliwrites Oct 26, 2022
535abc4
Merge branch 'master' into message_doc
quetzalliwrites Oct 26, 2022
4baa858
Update pages/docs/concepts/message.md
thulieblack Oct 28, 2022
7200329
Merge branch 'master' into message_doc
quetzalliwrites Oct 31, 2022
c2e86ca
Merge branch 'asyncapi:master' into message_doc
thulieblack Nov 2, 2022
fd8fae0
Merge branch 'master' into message_doc
quetzalliwrites Nov 7, 2022
35a4c63
Merge branch 'asyncapi:master' into message_doc
thulieblack Nov 8, 2022
2b90201
Update
thulieblack Nov 8, 2022
28f62b7
Update
thulieblack Nov 8, 2022
ca6e30d
Merge branch 'asyncapi:master' into message_doc
thulieblack Nov 8, 2022
a7822bf
Update message.md
thulieblack Nov 8, 2022
791996b
Merge branch 'master' into message_doc
akshatnema Nov 9, 2022
f404566
Merge branch 'master' into message_doc
quetzalliwrites Nov 9, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions pages/docs/concepts/message.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: Message
weight: 30
---

## What is a message?
A `message` is a communication asset used to transmit or exchange information from a sender to the receiver through `channels`. A single `message` can be consumed by multiple independent receivers and can also be defined as an _event_ or _command_. The sender includes a payload of data that needs to be processed and serialized by the receiver into an appropriate format, e.g., JSON, XML, binary, etc. It may also include metadata, i.e., information that describes the message itself. This metadata is often known as _headers_ or _properties_.


``` mermaid
graph LR
subgraph one[channel]
b([message])
end

A{{sender application}} --> b --> C{{receiver application}}
thulieblack marked this conversation as resolved.
Show resolved Hide resolved
quetzalliwrites marked this conversation as resolved.
Show resolved Hide resolved

```

In the diagram above, the sender application transmits a `message` to the receiver application.

## Messages vs Events
A `message` carries information from one application to the other, while an `event` is a message that provides details of something that has already occurred. One important aspect to note is that depending on the type of information a `message` contains, it can fall under an _event_, _query_, or _command_.
thulieblack marked this conversation as resolved.
Show resolved Hide resolved
*See the diagram below.*

``` mermaid
graph TD
A(Message)
A --> B(Event)
A --> C(Request)
C --> D(Query)
C --> E(Command)
```

Overall, `events` are `messages` but not all `messages` are `events`.

thulieblack marked this conversation as resolved.
Show resolved Hide resolved
---
<DocsButton
suggestions={[
{
href:'/docs/concepts/channel',
type: 'back',
title: 'Channel',
},
{
href:'/docs/tutorials',
type: 'next',
title: 'Tutorials - Overview',
}
]}
/>