From: Oleksii Shumeiko -X (oshumeik - SOFTSERVE INC at Cisco) <oshumeik@cisco.com>
Date: Tue, 15 Nov 2022 13:58:04 +0000 (+0000)
Subject: Pull request #3666: stream: add info about the splitter lifetime to dev_notes
X-Git-Tag: 3.1.47.0~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=bd0be57cd4c6fb2062e303660bd736a5eeab246f;p=thirdparty%2Fsnort3.git

Pull request #3666: stream: add info about the splitter lifetime to dev_notes

Merge in SNORT/snort3 from ~VHORBATO/snort3:doc_stream_splitter to master

Squashed commit of the following:

commit 56b229c22e0dda99808e23939928a1ab88366226
Author: Vitalii <vhorbato@cisco.com>
Date:   Tue Nov 15 10:51:22 2022 +0200

    stream: add info about the splitter lifetime to dev_notes
---

diff --git a/src/stream/dev_notes.txt b/src/stream/dev_notes.txt
index 746a9f52f..853883657 100644
--- a/src/stream/dev_notes.txt
+++ b/src/stream/dev_notes.txt
@@ -43,3 +43,5 @@ destroys the <protocol>HA class.  <protocol>HA is a subclass of ProtocolHA and i
 with the high level Stream HA functionality. <protocol>HA is instantiated in each packet
 processing thread.
 
+Note that the lifetime of any stream splitter instance should be less than the lifetime
+of the corresponding inspector instance.