X-Git-Url: http://git.efficios.com/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fcommon%2Fconsumer.h;h=830514659772b0afa6bb5de1ad7be678e033dcfb;hp=193533e926e12ea9b392686b24ff5559fccd8efb;hb=3604f373dd93990e0fd6342cfe4c657efaa171bb;hpb=3714380f76f56da2dfce53e07aa4f804a350047c

diff --git a/src/common/consumer.h b/src/common/consumer.h
index 193533e92..830514659 100644
--- a/src/common/consumer.h
+++ b/src/common/consumer.h
@@ -129,7 +129,19 @@ struct lttng_consumer_stream {
 	unsigned int metadata_flag;
 	/* Used when the stream is set for network streaming */
 	uint64_t relayd_stream_id;
-	/* Next sequence number to use for trace packet */
+	/*
+	 * When sending a stream packet to a relayd, this number is used to track
+	 * the packet sent by the consumer and seen by the relayd. When sending the
+	 * data header to the relayd, this number is sent and if the transmission
+	 * was successful, it is incremented.
+	 *
+	 * Even if the full data is not fully transmitted it won't matter since
+	 * only two possible error can happen after that where either the relayd
+	 * died or a read error is detected on the stream making this value useless
+	 * after that.
+	 *
+	 * This value SHOULD be read/updated atomically or with the lock acquired.
+	 */
 	uint64_t next_net_seq_num;
 	/*
 	 * Lock to use the stream FDs since they are used between threads.