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

Updated introduction (docs) #328

Merged
merged 1 commit into from
Jun 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added documentation/docs/assets/AddToOutbox.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/docs/assets/AddToTransport.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 13 additions & 3 deletions documentation/docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,27 @@ The following diagrams show the basic flow (omits details).
They are designed to provide a general understanding of how transactional box works.

### Outbox
:::info
The outbox is responsible for adding messages to the storage and then adding at least once to the transport.
:::
<div align="center">
![Outbox](assets/outbox.png)
![AddToOutbox](assets/AddToOutbox.png)
</div>

1. In one transaction you save message to outbox and result of business operation. In this way, you can ensure all or nothing. After correctly transaction commited, execute the `TransactionCommitted` method on `IOutbox`.
2. In a separate process, Outbox will get messages and add them to the transport.
In one transaction you save message to outbox and result of business operation. In this way, you can ensure all or nothing. After correctly transaction commited, execute the `TransactionCommitted` method on `IOutbox`.

<div align="center">
![AddToOutbox](assets/AddToTransport.png)
</div>

1. In a separate process, Outbox gets messages.
2. Then add them to the transport.
3. Then processed messages are clean up.

### Inbox
:::info
The inbox is responsible for getting messages from the transport and adding them to the storage, and then processes these messages.
:::
<div align="center">
![Inbox](assets/inbox.png)
</div>
Expand Down