LP#1612771: add release notes
[OpenSRF.git] / doc / Bundling-and-Chunking.txt
1 Message Bundling and Chunking
2 =============================
3
4 OpenSRF now supports message chunking, i.e., breaking up large OpenSRF
5 messages across multiple XMPP envelopes. This is implemented with a
6 new OpenSRF message type.
7
8 C, Perl, and Javascript libraries are taught how to reconstruct chunked
9 messages. The default chunking threshold is 50Kb, just a bit below the
10 default ejabberd max stanza size of 64Kb.
11
12 What was previously called chunking is now referred to as bundling:
13 packing multiple OpenSRF messages together in a single XMPP envelope,
14 as long as we believe more messages will be sent in the future and we
15 are below some threshold of combined message size.  The default for
16 that threshold is 25Kb.
17
18 With this change, it is no longer necessary to change the `max_stanza_size`
19 setting for ejabberd when installing OpenSRF.