search

industrial-data-space / idscp2-jvm

Kotlin implementation of the IDS Communication Protocol (IDSCP2) for use in JVM environments.
Apache License 2.0
4 stars 3 forks source link

Typo in the wiki #6

Open spetrac opened 2 years ago

spetrac commented 2 years ago

There is a minor typo in the wiki, but i stumbled uppon it when implementing the idscp2 fsm, because some states where a bit off. https://github.com/industrial-data-space/idscp2-java/wiki/IDSCP2-Core

In the description of the states ESTABLISHED and WAIT_FOR_ACK there are the events SC_DAT_EXPIRED and SC_RE_RA. As of the event description those events are probably meant to be SC_IDSCP_DAT_EXPIRED and SC_IDSCP_RE_RA.

This has no priority as the correct events are pretty obvious, but I wanted to report the typos anyway to help prevent copy-paste errors like mine.

milux commented 2 years ago

Thanks, but I didn't get your idea yet. Could you please elaborate? How does the suggested spelling change provide more clarity? What did you misunderstand from the original event names? We are speaking about the FSM of the IDSCP2 protocol, so everything is somewhat related to IDSCP2, right?

oxisto commented 2 years ago

Thanks, but I didn't get your idea yet. Could you please elaborate? How does the suggested spelling change provide more clarity? What did you misunderstand from the original event names? We are speaking about the FSM of the IDSCP2 protocol, so everything is somewhat related to IDSCP2, right?

In the event list and in most states its called SC_IDSCP_DAT_EXPIRED, but in the ESTABLISHED and WAIT_FOR_ACK state its called SC_DAT_EXPIRED, same for SC_RE_RA. It should always be called SC_IDSCP_DAT_EXPIRED I guess