InMemory Outbox
Reference · Applies to Brighter V10 · Prerequisites: InMemory Options for Development and Testing
The in-process Outbox: flushing, compaction, configuration and limits. It is part of Brighter's InMemory options for development and testing.
The InMemory Outbox provides transactional messaging support without requiring a database. Note that if you do not specify a persistent Outbox, we will use the InMemoryOutbox, by default. Any use of the CommandProcessor's Post method uses the default InMemoryOutbox and not the persistent Outbox, as it does not take a transaction provider as an argument.
InMemory Outbox Options
InMemoryBoxConfiguration carries the four settings that govern expiry and compaction. Assign it to producers.DefaultBoxConfiguration when you let Brighter create the default Outbox for you; when you construct an InMemoryOutbox yourself, set the same four as properties on the instance.
EntryLimit
int
2048
How many messages the Outbox holds before compaction runs; -1 disables compaction.
EntryTimeToLive
TimeSpan
300000 ms
How long a dispatched message remains in the Outbox before expiry removes it.
ExpirationScanInterval
TimeSpan
600000 ms
How long the Outbox waits between scans for expired messages.
CompactionPercentage
double
0.5
What fraction of EntryLimit the Outbox compacts down to.
EntryLimit rejects 0 and any value below -1 with ArgumentOutOfRangeException, so an invalid limit fails where you set it rather than at the first compaction.
Flush of Expired Messages
The InMemory Outbox will flush expired messages. You can configure the time limit for a message, after which it will be flushed:
EntryTimeToLive Governs how long a message can remain in the Outbox.
ExpirationScanInterval Governs how often a scan for expired messages runs.
Compaction of the InMemoryOutbox
The InMemoryOutbox's capacity is constrained. You can configure the limit to the number of messages the Outbox contains. If you are using the InMemoryOutbox in production scenarios, you should pay attention to this limit. Once the limit is hit, the Outbox will compact, removing older messages first. You can set a compaction percentage, which governs how many messages will be purged from the InMemoryOutbox when we compact.
EntryLimit Governs how many messages the InMemoryOutbox can hold.
CompactionPercentage When we hit a capacity limit, what percentage of messages should we purge.
When to Use the InMemory Outbox
Perfect for:
Testing transactional messaging patterns
Unit testing the Outbox pattern
Development without database dependencies
Production Use Cases (limited):
Single-process applications
Non-critical message publishing - the InMemoryOutbox is used in place of a persistent Outbox
Scenarios where message loss on restart is acceptable
InMemory Outbox Configuration
InMemory Outbox Example of Post
InMemory Outbox Limitations
No persistence: Messages lost on application restart
No transactions: Cannot participate in database transactions
Single process: State not shared across instances
Memory bound: All outstanding messages held in memory
Further Reading
InMemory Options for Development and Testing - The full set, and testing patterns
Last updated
Was this helpful?
