Skip to content

Commit b33b863

Browse files
committed
Code review: document that MSG_TYPE_FED_IDS include the type of the federate (persistent or transient)
1 parent 5975c39 commit b33b863

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

include/core/federated/network/net_common.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,10 @@ THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
4444
* When it has successfully opened a TCP connection, the first message it sends
4545
* to the RTI is a MSG_TYPE_FED_IDS message, which contains the ID of this federate
4646
* within the federation, contained in the global variable _lf_my_fed_id
47-
* in the federate code
48-
* (which is initialized by the code generator) and the unique ID of
49-
* the federation, a GUID that is created at run time by the generated script
50-
* that launches the federation.
47+
* in the federate code (which is initialized by the code generator),
48+
* the type of this federate (persistent (0) or transient (1)),
49+
* and the unique ID of the federation, a GUID that is created at run time by the
50+
* generated script that launches the federation.
5151
* If you launch the federates and the RTI manually, rather than using the script,
5252
* then the federation ID is a string that is optionally given to the federate
5353
* on the command line when it is launched. The federate will connect

0 commit comments

Comments
 (0)