Skip to content

Commit

Permalink
Code review: document that MSG_TYPE_FED_IDS include the type of the f…
Browse files Browse the repository at this point in the history
…ederate (persistent or transient)
  • Loading branch information
ChadliaJerad committed Mar 14, 2024
1 parent 5975c39 commit b33b863
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions include/core/federated/network/net_common.h
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* When it has successfully opened a TCP connection, the first message it sends
* to the RTI is a MSG_TYPE_FED_IDS message, which contains the ID of this federate
* within the federation, contained in the global variable _lf_my_fed_id
* in the federate code
* (which is initialized by the code generator) and the unique ID of
* the federation, a GUID that is created at run time by the generated script
* that launches the federation.
* in the federate code (which is initialized by the code generator),
* the type of this federate (persistent (0) or transient (1)),
* and the unique ID of the federation, a GUID that is created at run time by the
* generated script that launches the federation.
* If you launch the federates and the RTI manually, rather than using the script,
* then the federation ID is a string that is optionally given to the federate
* on the command line when it is launched. The federate will connect
Expand Down

0 comments on commit b33b863

Please sign in to comment.