add an important comment about transportFSM being single-thread and synchronous

This commit is contained in:
Paul Davis 2019-09-20 09:35:08 -06:00
parent b075c67e51
commit 6b12264d40

View file

@ -22,9 +22,14 @@ class TransportAPI;
struct TransportFSM
{
public:
/* events to be delivered to the FSM */
/* All code related to this object is expected to be run synchronously
* and single-threaded from the process callback. It can be re-entrant
* if handling one transport state change queues another state change,
* but that is handled explicitly (see the @param processing member and
* its usage).
*/
public:
enum EventType {
ButlerDone,
ButlerRequired,