added comments

lathoub · lathoub · commit 6e5e75cea9a4 · 2026-02-21T18:38:52.000+01:00
diff --git a/src/AppleMIDI.hpp b/src/AppleMIDI.hpp
@@ -5,6 +5,7 @@
 
 BEGIN_APPLEMIDI_NAMESPACE
 
+// Read pending control UDP packets into the control buffer.
 template <class UdpClass, class Settings, class Platform>
 size_t AppleMIDISession<UdpClass, Settings, Platform>::readControlPackets()
 {
@@ -24,6 +25,7 @@ size_t AppleMIDISession<UdpClass, Settings, Platform>::readControlPackets()
     return controlBuffer.size();
 }
 
+// Parse buffered control packets and handle errors.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::parseControlPackets()
 {
@@ -52,6 +54,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::parseControlPackets()
     }
 }
 
+// Read pending data UDP packets into the data buffer.
 template <class UdpClass, class Settings, class Platform>
 size_t AppleMIDISession<UdpClass, Settings, Platform>::readDataPackets()
 {
@@ -71,6 +74,7 @@ size_t AppleMIDISession<UdpClass, Settings, Platform>::readDataPackets()
     return dataBuffer.size();
 }
 
+// Parse buffered data packets using RTP-MIDI and AppleMIDI parsers.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::parseDataPackets()
 {
@@ -104,6 +108,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::parseDataPackets()
     }
 }
 
+// Route an invitation based on the incoming port type.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedInvitation(AppleMIDI_Invitation_t &invitation, const amPortType &portType)
 {
@@ -113,6 +118,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedInvitation(AppleMID
         ReceivedDataInvitation(invitation);
 }
 
+// Handle an incoming control invitation from a remote participant.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedControlInvitation(AppleMIDI_Invitation_t &invitation)
 {
@@ -188,6 +194,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedControlInvitation(A
     writeInvitation(controlPort, participant.remoteIP, participant.remotePort, invitation, amInvitationAccepted);
 }
 
+// Handle an incoming data invitation for an existing participant.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedDataInvitation(AppleMIDI_Invitation &invitation)
 {
@@ -233,12 +240,14 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedDataInvitation(Appl
     }
 }
 
+// Placeholder for bitrate receive limit messages (not used).
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedBitrateReceiveLimit(AppleMIDI_BitrateReceiveLimit &)
 {
 }
 
 #ifdef APPLEMIDI_INITIATOR
+// Route accepted invitations based on the incoming port type.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedInvitationAccepted(AppleMIDI_InvitationAccepted_t &invitationAccepted, const amPortType &portType)
 {
@@ -248,6 +257,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedInvitationAccepted(
         ReceivedDataInvitationAccepted(invitationAccepted);
 }
 
+// Update participant state after control invitation acceptance.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedControlInvitationAccepted(AppleMIDI_InvitationAccepted_t &invitationAccepted)
 {
@@ -271,6 +281,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedControlInvitationAc
 #endif
 }
 
+// Update participant state after data invitation acceptance.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedDataInvitationAccepted(AppleMIDI_InvitationAccepted_t &invitationAccepted)
 {
@@ -287,6 +298,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedDataInvitationAccep
     pParticipant->invitationStatus = DataInvitationAccepted;
 }
 
+// Remove participant on invitation rejection.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedInvitationRejected(AppleMIDI_InvitationRejected_t & invitationRejected)
 {
@@ -305,6 +317,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedInvitationRejected(
 }
 #endif
 
+// Handle an incoming synchronization exchange packet.
 /*! \brief .
 
 From: http://en.wikipedia.org/wiki/RTP_MIDI
@@ -416,6 +429,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedSynchronization(App
 // encapsulate only those changes to the MIDI stream state occurring after
 // the specified packet number.
 //
+// Process receiver feedback about last received sequence numbers.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedReceiverFeedback(AppleMIDI_ReceiverFeedback_t &receiverFeedback)
 {
@@ -443,6 +457,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedReceiverFeedback(Ap
     }
 }
 
+// Handle end-session requests and notify callbacks.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedEndSession(AppleMIDI_EndSession_t &endSession)
 {
@@ -471,6 +486,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedEndSession(AppleMID
 }
 
 #ifdef USE_DIRECTORY
+// Check whether a remote IP is in the allowed directory list.
 template <class UdpClass, class Settings, class Platform>
 bool AppleMIDISession<UdpClass, Settings, Platform>::IsComputerInDirectory(IPAddress remoteIP) const
 {
@@ -482,6 +498,7 @@ bool AppleMIDISession<UdpClass, Settings, Platform>::IsComputerInDirectory(IPAdd
 #endif
 
 #ifndef ONE_PARTICIPANT
+// Find a participant by SSRC.
 template <class UdpClass, class Settings, class Platform>
 Participant<Settings>* AppleMIDISession<UdpClass, Settings, Platform>::getParticipantBySSRC(const ssrc_t& ssrc)
 {
@@ -491,6 +508,7 @@ Participant<Settings>* AppleMIDISession<UdpClass, Settings, Platform>::getPartic
     return nullptr;
 }
 
+// Find a participant by initiator token.
 template <class UdpClass, class Settings, class Platform>
 Participant<Settings>* AppleMIDISession<UdpClass, Settings, Platform>::getParticipantByInitiatorToken(const uint32_t& initiatorToken)
 {
@@ -501,6 +519,7 @@ Participant<Settings>* AppleMIDISession<UdpClass, Settings, Platform>::getPartic
 }
 #endif
 
+// Serialize and send an invitation packet on the given port.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::writeInvitation(UdpClass &port, const IPAddress& remoteIP, const uint16_t& remotePort, AppleMIDI_Invitation_t & invitation, const byte *command)
 {
@@ -526,6 +545,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::writeInvitation(UdpClass &p
     port.flush();
 }
 
+// Send receiver feedback on the control port.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::writeReceiverFeedback(const IPAddress& remoteIP, const uint16_t & remotePort, AppleMIDI_ReceiverFeedback_t & receiverFeedback)
 {
@@ -551,6 +571,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::writeReceiverFeedback(const
     controlPort.flush();
 }
 
+// Send a synchronization packet on the data port.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::writeSynchronization(const IPAddress& remoteIP, const uint16_t & remotePort, AppleMIDI_Synchronization_t &synchronization)
 {
@@ -577,6 +598,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::writeSynchronization(const
     dataPort.flush();
 }
 
+// Send an end-session packet on the control port.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::writeEndSession(const IPAddress& remoteIP, const uint16_t & remotePort, AppleMIDI_EndSession_t &endSession)
 {
@@ -602,6 +624,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::writeEndSession(const IPAdd
     controlPort.flush();
 }
 
+// Flush the outgoing MIDI buffer to all participants.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::writeRtpMidiToAllParticipants()
 {
@@ -618,6 +641,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::writeRtpMidiToAllParticipan
     outMidiBuffer.clear();
 }
 
+// Build and send an RTP-MIDI packet for a participant.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::writeRtpMidiBuffer(Participant<Settings>* participant)
 { 
@@ -741,9 +765,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::writeRtpMidiBuffer(Particip
 #endif
 }
 
-//
-//
-//
+// Manage synchronization state for all active participants.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::manageSynchronization()
 {
@@ -807,13 +829,10 @@ void AppleMIDISession<UdpClass, Settings, Platform>::manageSynchronization()
 
 #ifdef APPLEMIDI_INITIATOR
 
-//
-// The initiator of the session polls if remote station is still alive.
-// (Initiators only)
+// Initiator heartbeat: schedule periodic synchronization exchanges.
 //
 // The initiator must initiate a new sync exchange at least once every 60 seconds;
 // otherwise the responder may assume that the initiator has died and terminate the session.
-//
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::manageSynchronizationInitiatorHeartBeat(Participant<Settings>* pParticipant)
 {
@@ -850,7 +869,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::manageSynchronizationInitia
     sendSynchronization(pParticipant);
 }
 
-// checks for
+// Retry sync invitations while establishing synchronization.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::manageSynchronizationInitiatorInvites(size_t i)
 {
@@ -880,6 +899,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::manageSynchronizationInitia
 
 #endif
 
+// Send a CK0 synchronization message to a participant.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::sendSynchronization(Participant<Settings>* participant)
 {
@@ -895,7 +915,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::sendSynchronization(Partici
     participant->lastInviteSentTime = now;
 }
 
-// (Initiators only)
+// Manage invitation retries for session establishment (initiators only).
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::manageSessionInvites()
 {
@@ -991,6 +1011,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::manageSessionInvites()
     }
 }
 
+// Periodically emit receiver feedback for active participants.
 // The recovery journal mechanism requires that the receiver
 // periodically inform the sender of the sequence number of the most
 // recently received packet. This allows the sender to reduce the size
@@ -1035,6 +1056,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::manageReceiverFeedback()
 
 #ifdef APPLEMIDI_INITIATOR
 
+// Queue a new outgoing invitation for a remote endpoint.
 template <class UdpClass, class Settings, class Platform>
 bool AppleMIDISession<UdpClass, Settings, Platform>::sendInvite(IPAddress ip, uint16_t port)
 {
@@ -1067,6 +1089,7 @@ bool AppleMIDISession<UdpClass, Settings, Platform>::sendInvite(IPAddress ip, ui
 
 #endif
 
+// Send end-session to all participants and clear them.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::sendEndSession()
 {
@@ -1087,6 +1110,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::sendEndSession()
 #endif
 }
 
+// Send end-session to a single participant and notify callbacks.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::sendEndSession(Participant<Settings>* participant)
 {
@@ -1099,6 +1123,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::sendEndSession(Participant<
         _disconnectedCallback(participant->ssrc);
 }
 
+// Handle an incoming RTP header and track latency/sequence.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedRtp(const Rtp_t& rtp)
 {
@@ -1139,6 +1164,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedRtp(const Rtp_t& rt
     }
 }
 
+// Notify that a MIDI byte stream has started.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::StartReceivedMidi()
 {
@@ -1148,6 +1174,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::StartReceivedMidi()
 #endif
 }
 
+// Handle a received MIDI byte and buffer it.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedMidi(byte value)
 {
@@ -1159,6 +1186,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedMidi(byte value)
     inMidiBuffer.push_back(value);
 }
 
+// Notify that a MIDI byte stream has ended.
 template <class UdpClass, class Settings, class Platform>
 void AppleMIDISession<UdpClass, Settings, Platform>::EndReceivedMidi()
 {

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`
`6`	`6`	`BEGIN_APPLEMIDI_NAMESPACE`
`7`	`7`
	`8`	`+// Read pending control UDP packets into the control buffer.`
`8`	`9`	`template <class UdpClass, class Settings, class Platform>`
`9`	`10`	`size_t AppleMIDISession<UdpClass, Settings, Platform>::readControlPackets()`
`10`	`11`	`{`
`@@ -24,6 +25,7 @@ size_t AppleMIDISession<UdpClass, Settings, Platform>::readControlPackets()`
`24`	`25`	`return controlBuffer.size();`
`25`	`26`	`}`
`26`	`27`
	`28`	`+// Parse buffered control packets and handle errors.`
`27`	`29`	`template <class UdpClass, class Settings, class Platform>`
`28`	`30`	`void AppleMIDISession<UdpClass, Settings, Platform>::parseControlPackets()`
`29`	`31`	`{`
`@@ -52,6 +54,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::parseControlPackets()`
`52`	`54`	`}`
`53`	`55`	`}`
`54`	`56`
	`57`	`+// Read pending data UDP packets into the data buffer.`
`55`	`58`	`template <class UdpClass, class Settings, class Platform>`
`56`	`59`	`size_t AppleMIDISession<UdpClass, Settings, Platform>::readDataPackets()`
`57`	`60`	`{`
`@@ -71,6 +74,7 @@ size_t AppleMIDISession<UdpClass, Settings, Platform>::readDataPackets()`
`71`	`74`	`return dataBuffer.size();`
`72`	`75`	`}`
`73`	`76`
	`77`	`+// Parse buffered data packets using RTP-MIDI and AppleMIDI parsers.`
`74`	`78`	`template <class UdpClass, class Settings, class Platform>`
`75`	`79`	`void AppleMIDISession<UdpClass, Settings, Platform>::parseDataPackets()`
`76`	`80`	`{`
`@@ -104,6 +108,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::parseDataPackets()`
`104`	`108`	`}`
`105`	`109`	`}`
`106`	`110`
	`111`	`+// Route an invitation based on the incoming port type.`
`107`	`112`	`template <class UdpClass, class Settings, class Platform>`
`108`	`113`	`void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedInvitation(AppleMIDI_Invitation_t &invitation, const amPortType &portType)`
`109`	`114`	`{`
`@@ -113,6 +118,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedInvitation(AppleMID`
`113`	`118`	`ReceivedDataInvitation(invitation);`
`114`	`119`	`}`
`115`	`120`
	`121`	`+// Handle an incoming control invitation from a remote participant.`
`116`	`122`	`template <class UdpClass, class Settings, class Platform>`
`117`	`123`	`void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedControlInvitation(AppleMIDI_Invitation_t &invitation)`
`118`	`124`	`{`
`@@ -188,6 +194,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedControlInvitation(A`
`188`	`194`	`writeInvitation(controlPort, participant.remoteIP, participant.remotePort, invitation, amInvitationAccepted);`
`189`	`195`	`}`
`190`	`196`
	`197`	`+// Handle an incoming data invitation for an existing participant.`
`191`	`198`	`template <class UdpClass, class Settings, class Platform>`
`192`	`199`	`void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedDataInvitation(AppleMIDI_Invitation &invitation)`
`193`	`200`	`{`
`@@ -233,12 +240,14 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedDataInvitation(Appl`
`233`	`240`	`}`
`234`	`241`	`}`
`235`	`242`
	`243`	`+// Placeholder for bitrate receive limit messages (not used).`
`236`	`244`	`template <class UdpClass, class Settings, class Platform>`
`237`	`245`	`void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedBitrateReceiveLimit(AppleMIDI_BitrateReceiveLimit &)`
`238`	`246`	`{`
`239`	`247`	`}`
`240`	`248`
`241`	`249`	`#ifdef APPLEMIDI_INITIATOR`
	`250`	`+// Route accepted invitations based on the incoming port type.`
`242`	`251`	`template <class UdpClass, class Settings, class Platform>`
`243`	`252`	`void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedInvitationAccepted(AppleMIDI_InvitationAccepted_t &invitationAccepted, const amPortType &portType)`
`244`	`253`	`{`
`@@ -248,6 +257,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedInvitationAccepted(`
`248`	`257`	`ReceivedDataInvitationAccepted(invitationAccepted);`
`249`	`258`	`}`
`250`	`259`
	`260`	`+// Update participant state after control invitation acceptance.`
`251`	`261`	`template <class UdpClass, class Settings, class Platform>`
`252`	`262`	`void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedControlInvitationAccepted(AppleMIDI_InvitationAccepted_t &invitationAccepted)`
`253`	`263`	`{`
`@@ -271,6 +281,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedControlInvitationAc`
`271`	`281`	`#endif`
`272`	`282`	`}`
`273`	`283`
	`284`	`+// Update participant state after data invitation acceptance.`
`274`	`285`	`template <class UdpClass, class Settings, class Platform>`
`275`	`286`	`void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedDataInvitationAccepted(AppleMIDI_InvitationAccepted_t &invitationAccepted)`
`276`	`287`	`{`
`@@ -287,6 +298,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedDataInvitationAccep`
`287`	`298`	`pParticipant->invitationStatus = DataInvitationAccepted;`
`288`	`299`	`}`
`289`	`300`
	`301`	`+// Remove participant on invitation rejection.`
`290`	`302`	`template <class UdpClass, class Settings, class Platform>`
`291`	`303`	`void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedInvitationRejected(AppleMIDI_InvitationRejected_t & invitationRejected)`
`292`	`304`	`{`
`@@ -305,6 +317,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedInvitationRejected(`
`305`	`317`	`}`
`306`	`318`	`#endif`
`307`	`319`
	`320`	`+// Handle an incoming synchronization exchange packet.`
`308`	`321`	`/*! \brief .`
`309`	`322`
`310`	`323`	`From: http://en.wikipedia.org/wiki/RTP_MIDI`
`@@ -416,6 +429,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedSynchronization(App`
`416`	`429`	`// encapsulate only those changes to the MIDI stream state occurring after`
`417`	`430`	`// the specified packet number.`
`418`	`431`	`//`
	`432`	`+// Process receiver feedback about last received sequence numbers.`
`419`	`433`	`template <class UdpClass, class Settings, class Platform>`
`420`	`434`	`void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedReceiverFeedback(AppleMIDI_ReceiverFeedback_t &receiverFeedback)`
`421`	`435`	`{`
`@@ -443,6 +457,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedReceiverFeedback(Ap`
`443`	`457`	`}`
`444`	`458`	`}`
`445`	`459`
	`460`	`+// Handle end-session requests and notify callbacks.`
`446`	`461`	`template <class UdpClass, class Settings, class Platform>`
`447`	`462`	`void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedEndSession(AppleMIDI_EndSession_t &endSession)`
`448`	`463`	`{`
`@@ -471,6 +486,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedEndSession(AppleMID`
`471`	`486`	`}`
`472`	`487`
`473`	`488`	`#ifdef USE_DIRECTORY`
	`489`	`+// Check whether a remote IP is in the allowed directory list.`
`474`	`490`	`template <class UdpClass, class Settings, class Platform>`
`475`	`491`	`bool AppleMIDISession<UdpClass, Settings, Platform>::IsComputerInDirectory(IPAddress remoteIP) const`
`476`	`492`	`{`
`@@ -482,6 +498,7 @@ bool AppleMIDISession<UdpClass, Settings, Platform>::IsComputerInDirectory(IPAdd`
`482`	`498`	`#endif`
`483`	`499`
`484`	`500`	`#ifndef ONE_PARTICIPANT`
	`501`	`+// Find a participant by SSRC.`
`485`	`502`	`template <class UdpClass, class Settings, class Platform>`
`486`	`503`	`Participant<Settings>* AppleMIDISession<UdpClass, Settings, Platform>::getParticipantBySSRC(const ssrc_t& ssrc)`
`487`	`504`	`{`
`@@ -491,6 +508,7 @@ Participant<Settings>* AppleMIDISession<UdpClass, Settings, Platform>::getPartic`
`491`	`508`	`return nullptr;`
`492`	`509`	`}`
`493`	`510`
	`511`	`+// Find a participant by initiator token.`
`494`	`512`	`template <class UdpClass, class Settings, class Platform>`
`495`	`513`	`Participant<Settings>* AppleMIDISession<UdpClass, Settings, Platform>::getParticipantByInitiatorToken(const uint32_t& initiatorToken)`
`496`	`514`	`{`
`@@ -501,6 +519,7 @@ Participant<Settings>* AppleMIDISession<UdpClass, Settings, Platform>::getPartic`
`501`	`519`	`}`
`502`	`520`	`#endif`
`503`	`521`
	`522`	`+// Serialize and send an invitation packet on the given port.`
`504`	`523`	`template <class UdpClass, class Settings, class Platform>`
`505`	`524`	`void AppleMIDISession<UdpClass, Settings, Platform>::writeInvitation(UdpClass &port, const IPAddress& remoteIP, const uint16_t& remotePort, AppleMIDI_Invitation_t & invitation, const byte *command)`
`506`	`525`	`{`
`@@ -526,6 +545,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::writeInvitation(UdpClass &p`
`526`	`545`	`port.flush();`
`527`	`546`	`}`
`528`	`547`
	`548`	`+// Send receiver feedback on the control port.`
`529`	`549`	`template <class UdpClass, class Settings, class Platform>`
`530`	`550`	`void AppleMIDISession<UdpClass, Settings, Platform>::writeReceiverFeedback(const IPAddress& remoteIP, const uint16_t & remotePort, AppleMIDI_ReceiverFeedback_t & receiverFeedback)`
`531`	`551`	`{`
`@@ -551,6 +571,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::writeReceiverFeedback(const`
`551`	`571`	`controlPort.flush();`
`552`	`572`	`}`
`553`	`573`
	`574`	`+// Send a synchronization packet on the data port.`
`554`	`575`	`template <class UdpClass, class Settings, class Platform>`
`555`	`576`	`void AppleMIDISession<UdpClass, Settings, Platform>::writeSynchronization(const IPAddress& remoteIP, const uint16_t & remotePort, AppleMIDI_Synchronization_t &synchronization)`
`556`	`577`	`{`
`@@ -577,6 +598,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::writeSynchronization(const`
`577`	`598`	`dataPort.flush();`
`578`	`599`	`}`
`579`	`600`
	`601`	`+// Send an end-session packet on the control port.`
`580`	`602`	`template <class UdpClass, class Settings, class Platform>`
`581`	`603`	`void AppleMIDISession<UdpClass, Settings, Platform>::writeEndSession(const IPAddress& remoteIP, const uint16_t & remotePort, AppleMIDI_EndSession_t &endSession)`
`582`	`604`	`{`
`@@ -602,6 +624,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::writeEndSession(const IPAdd`
`602`	`624`	`controlPort.flush();`
`603`	`625`	`}`
`604`	`626`
	`627`	`+// Flush the outgoing MIDI buffer to all participants.`
`605`	`628`	`template <class UdpClass, class Settings, class Platform>`
`606`	`629`	`void AppleMIDISession<UdpClass, Settings, Platform>::writeRtpMidiToAllParticipants()`
`607`	`630`	`{`
`@@ -618,6 +641,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::writeRtpMidiToAllParticipan`
`618`	`641`	`outMidiBuffer.clear();`
`619`	`642`	`}`
`620`	`643`
	`644`	`+// Build and send an RTP-MIDI packet for a participant.`
`621`	`645`	`template <class UdpClass, class Settings, class Platform>`
`622`	`646`	`void AppleMIDISession<UdpClass, Settings, Platform>::writeRtpMidiBuffer(Participant<Settings>* participant)`
`623`	`647`	`{`
`@@ -741,9 +765,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::writeRtpMidiBuffer(Particip`
`741`	`765`	`#endif`
`742`	`766`	`}`
`743`	`767`
`744`		`-//`
`745`		`-//`
`746`		`-//`
	`768`	`+// Manage synchronization state for all active participants.`
`747`	`769`	`template <class UdpClass, class Settings, class Platform>`
`748`	`770`	`void AppleMIDISession<UdpClass, Settings, Platform>::manageSynchronization()`
`749`	`771`	`{`
`@@ -807,13 +829,10 @@ void AppleMIDISession<UdpClass, Settings, Platform>::manageSynchronization()`
`807`	`829`
`808`	`830`	`#ifdef APPLEMIDI_INITIATOR`
`809`	`831`
`810`		`-//`
`811`		`-// The initiator of the session polls if remote station is still alive.`
`812`		`-// (Initiators only)`
	`832`	`+// Initiator heartbeat: schedule periodic synchronization exchanges.`
`813`	`833`	`//`
`814`	`834`	`// The initiator must initiate a new sync exchange at least once every 60 seconds;`
`815`	`835`	`// otherwise the responder may assume that the initiator has died and terminate the session.`
`816`		`-//`
`817`	`836`	`template <class UdpClass, class Settings, class Platform>`
`818`	`837`	`void AppleMIDISession<UdpClass, Settings, Platform>::manageSynchronizationInitiatorHeartBeat(Participant<Settings>* pParticipant)`
`819`	`838`	`{`
`@@ -850,7 +869,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::manageSynchronizationInitia`
`850`	`869`	`sendSynchronization(pParticipant);`
`851`	`870`	`}`
`852`	`871`
`853`		`-// checks for`
	`872`	`+// Retry sync invitations while establishing synchronization.`
`854`	`873`	`template <class UdpClass, class Settings, class Platform>`
`855`	`874`	`void AppleMIDISession<UdpClass, Settings, Platform>::manageSynchronizationInitiatorInvites(size_t i)`
`856`	`875`	`{`
`@@ -880,6 +899,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::manageSynchronizationInitia`
`880`	`899`
`881`	`900`	`#endif`
`882`	`901`
	`902`	`+// Send a CK0 synchronization message to a participant.`
`883`	`903`	`template <class UdpClass, class Settings, class Platform>`
`884`	`904`	`void AppleMIDISession<UdpClass, Settings, Platform>::sendSynchronization(Participant<Settings>* participant)`
`885`	`905`	`{`
`@@ -895,7 +915,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::sendSynchronization(Partici`
`895`	`915`	`participant->lastInviteSentTime = now;`
`896`	`916`	`}`
`897`	`917`
`898`		`-// (Initiators only)`
	`918`	`+// Manage invitation retries for session establishment (initiators only).`
`899`	`919`	`template <class UdpClass, class Settings, class Platform>`
`900`	`920`	`void AppleMIDISession<UdpClass, Settings, Platform>::manageSessionInvites()`
`901`	`921`	`{`
`@@ -991,6 +1011,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::manageSessionInvites()`
`991`	`1011`	`}`
`992`	`1012`	`}`
`993`	`1013`
	`1014`	`+// Periodically emit receiver feedback for active participants.`
`994`	`1015`	`// The recovery journal mechanism requires that the receiver`
`995`	`1016`	`// periodically inform the sender of the sequence number of the most`
`996`	`1017`	`// recently received packet. This allows the sender to reduce the size`
`@@ -1035,6 +1056,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::manageReceiverFeedback()`
`1035`	`1056`
`1036`	`1057`	`#ifdef APPLEMIDI_INITIATOR`
`1037`	`1058`
	`1059`	`+// Queue a new outgoing invitation for a remote endpoint.`
`1038`	`1060`	`template <class UdpClass, class Settings, class Platform>`
`1039`	`1061`	`bool AppleMIDISession<UdpClass, Settings, Platform>::sendInvite(IPAddress ip, uint16_t port)`
`1040`	`1062`	`{`
`@@ -1067,6 +1089,7 @@ bool AppleMIDISession<UdpClass, Settings, Platform>::sendInvite(IPAddress ip, ui`
`1067`	`1089`
`1068`	`1090`	`#endif`
`1069`	`1091`
	`1092`	`+// Send end-session to all participants and clear them.`
`1070`	`1093`	`template <class UdpClass, class Settings, class Platform>`
`1071`	`1094`	`void AppleMIDISession<UdpClass, Settings, Platform>::sendEndSession()`
`1072`	`1095`	`{`
`@@ -1087,6 +1110,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::sendEndSession()`
`1087`	`1110`	`#endif`
`1088`	`1111`	`}`
`1089`	`1112`
	`1113`	`+// Send end-session to a single participant and notify callbacks.`
`1090`	`1114`	`template <class UdpClass, class Settings, class Platform>`
`1091`	`1115`	`void AppleMIDISession<UdpClass, Settings, Platform>::sendEndSession(Participant<Settings>* participant)`
`1092`	`1116`	`{`
`@@ -1099,6 +1123,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::sendEndSession(Participant<`
`1099`	`1123`	`_disconnectedCallback(participant->ssrc);`
`1100`	`1124`	`}`
`1101`	`1125`
	`1126`	`+// Handle an incoming RTP header and track latency/sequence.`
`1102`	`1127`	`template <class UdpClass, class Settings, class Platform>`
`1103`	`1128`	`void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedRtp(const Rtp_t& rtp)`
`1104`	`1129`	`{`
`@@ -1139,6 +1164,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedRtp(const Rtp_t& rt`
`1139`	`1164`	`}`
`1140`	`1165`	`}`
`1141`	`1166`
	`1167`	`+// Notify that a MIDI byte stream has started.`
`1142`	`1168`	`template <class UdpClass, class Settings, class Platform>`
`1143`	`1169`	`void AppleMIDISession<UdpClass, Settings, Platform>::StartReceivedMidi()`
`1144`	`1170`	`{`
`@@ -1148,6 +1174,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::StartReceivedMidi()`
`1148`	`1174`	`#endif`
`1149`	`1175`	`}`
`1150`	`1176`
	`1177`	`+// Handle a received MIDI byte and buffer it.`
`1151`	`1178`	`template <class UdpClass, class Settings, class Platform>`
`1152`	`1179`	`void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedMidi(byte value)`
`1153`	`1180`	`{`
`@@ -1159,6 +1186,7 @@ void AppleMIDISession<UdpClass, Settings, Platform>::ReceivedMidi(byte value)`
`1159`	`1186`	`inMidiBuffer.push_back(value);`
`1160`	`1187`	`}`
`1161`	`1188`
	`1189`	`+// Notify that a MIDI byte stream has ended.`
`1162`	`1190`	`template <class UdpClass, class Settings, class Platform>`
`1163`	`1191`	`void AppleMIDISession<UdpClass, Settings, Platform>::EndReceivedMidi()`
`1164`	`1192`	`{`