Skip to content

Commit c9ae897

Browse files
committed
Add concurrency information for Sink.
1 parent 33e18c1 commit c9ae897

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

sog/sink.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ namespace sog {
2424
* use of sog sources are never destructed but there is an API provided
2525
* for "dynamic" logging in which the destruction of sources is common.
2626
*
27+
* @warning This function must be reentrant. It will only be called once
28+
* for any given source but it may be called for multiple sources
29+
* concurrently.
30+
*
2731
* @param source The source to prepare for.
2832
* @return Arbitrary data.
2933
*/
@@ -36,6 +40,9 @@ namespace sog {
3640
* (both in location and content) as the source passed to the prepare()
3741
* call that produced sink_data.
3842
*
43+
* @warning This function must be reentrant. It will be called
44+
* concurrently for the same and different sinks.
45+
*
3946
* @param sink_data Data from a previous call to prepare()
4047
* @param msg The message to log.
4148
*/

0 commit comments

Comments
 (0)