Skip to content

Commit a6814be

Browse files
committed
Documentation for LineBufferProxy.
Signed-off-by: Jan Losinski <[email protected]>
1 parent 533ac6e commit a6814be

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,12 @@ That means, that when you configure a handler for a certain level, you'll get ev
2020
The available levels are: `ERROR`, `WARNING`, `INFO`, `DEBUG` with debug the highest level.
2121
So if you configure your Handler for `DEBUG`, you'll get messages for all levels.
2222
If you configure for `ERROR`, you'll get only error messages.
23+
24+
## Line- or message buffering
25+
26+
The template `LineBufferProxy` implements a simple proxy to buffer messages and send them line- or messagewise to some target.
27+
Simply inherit from it and implement the `flush()` method.
28+
It is called when either the internal buffer is full or the `Sep` char was found.
29+
The String it gets is always null terminated.
30+
The `size()` can be used if the length is needed.
31+
So you can save the time of a `strlen()`.

0 commit comments

Comments
 (0)