[solanum.git] / librb / README.md

# librb

This is based on libratbox, the common runtime support code in ircd-ratbox.
It has significant modifications and is no longer compatible with libratbox itself (nor can be used as a dropin replacement), so we renamed it.

# original libratbox notes

1. Most of this code isn't anywhere near threadsafe at this point.  Don't
   hold your breath on this either.
2. The linebuf code is designed to deal with pretty much 512 bytes per line
   and that is it.  Anything beyond that length unless in raw mode, gets
   discard.  For some non-irc purposes, this can be a problem, but for
   ircd stuff its fine.
3. The helper code when transmitting data between helpers, the same 512 byte
   limit applies there as we recycle the linebuf code for this.
Commit	Line	Data
4c1873ed AC	1	# librb
	2
	3	This is based on libratbox, the common runtime support code in ircd-ratbox.
	4	It has significant modifications and is no longer compatible with libratbox itself (nor can be used as a dropin replacement), so we renamed it.
	5
	6	# original libratbox notes
db137867 AC	7
	8	1. Most of this code isn't anywhere near threadsafe at this point. Don't
	9	hold your breath on this either.
	10	2. The linebuf code is designed to deal with pretty much 512 bytes per line
	11	and that is it. Anything beyond that length unless in raw mode, gets
	12	discard. For some non-irc purposes, this can be a problem, but for
	13	ircd stuff its fine.
	14	3. The helper code when transmitting data between helpers, the same 512 byte
3202e249	15	limit applies there as we recycle the linebuf code for this.